search

tursodatabase / turso-docs

Turso reference documentation
https://docs.turso.tech
MIT License
11 stars 48 forks source link

Tutorial Section Improvement on the Docs #35

Closed BrightonMboya closed 1 year ago

BrightonMboya commented 1 year ago

I suggest the client access details could look better if it was under Tutorials section. It is kinda not intuitive when it is in the reference section. I can work on this and submit a PR if it makes sense to the team.

CodingDoug commented 1 year ago

The way it was intended for those sections to work is like this:

Reference: Contains factual descriptions of how the parts of the system work including copyable samples where appropriate.

Tutorials: Step-by-step instructions on getting things to work.

As it stands now, the client access section doesn't fit the tutorials section because 1) the pages don't read like step-by-step instructions, and 2) someone could jump into the middle of the page to look for info and snippets of relevance.

There is actually a pretty big change coming where there will be two docs sites, one for everything originating from libSQL (the open source components from https://github.com/libsql, especially the client libraries and sqld), and one for all of the things that Turso adds to it (CLI, managed hosting behavior, and the tutorials that make use of Turso services). In light of all those changes coming, it's probably best to hold steady for the moment and wait for that to settle.