Closed IronCore864 closed 4 months ago
Hi @IronCore864 , this is a lot clearer, thanks!
2 changes for now:
I can see the content starting to modularise, which will make it easy to keep each section clean, avoid duplicates, and easy to cross-reference.
I do think some sections should be merged or added.
pebble help
, the commands are categorised, but the current README doesn't necessarily address "Info" (e.g. managing your Pebble installation in terms of version, updating to a newer version), or "Files". But this can be done in a separate PR.Overall I think it's a good start. I only left 1 minor comment about the title for the How-to index page; but other than that I think it's good to go for the first draft.
Thanks!
Splitting the README documentation into smaller chunks into the docs folder, using the Diataxis method.
Click here to see the preview..
Major changes:
TODO: The current tutorial (
docs/tutorial/getting-started.md
) is too long, maybe we need to split it into smaller chunks, some fit into the "how-to" category while others may fit into the "explanations" more.