surrealdb / docs.surrealdb.com

The documentation for SurrealDB, powered by Docusaurus
https://surrealdb.com/docs/
70 stars 112 forks source link

Docs: Clarify a bit more on SurrealQL running options in the getting started guide #648

Closed matthewjnield closed 2 months ago

matthewjnield commented 2 months ago

This commit updates the 1.x and 2.x documentation, within the "Introduction" section, on the "Getting Started" page ("start.mdx"), making the following changes:

netlify[bot] commented 2 months ago

Deploy Preview for surrealdb-docs ready!

Name Link
Latest commit fed80012cb7758bbb951169c66b0ad922dcffd69
Latest deploy log https://app.netlify.com/sites/surrealdb-docs/deploys/668a8bede1b79f000800a4dc
Deploy Preview https://deploy-preview-648--surrealdb-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

matthewjnield commented 2 months ago

@Ekwuno , thank you for taking the time to review this PR. I think formatting the items in a numbered list as opposed to one long paragraph is a great approach.

The only other consideration I have is whether a third item in the list describing SDKs for programming languages belongs here. It is certainly a method of "Running queries in SurrealDB" as the header section header describes, but it may not technically be "a way to use SurrealQL" as the sentence before the numbered list says. Let me know what you think.