canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
10 stars 30 forks source link

Consider re-organizing the README #241

Open YanisaHS opened 1 month ago

YanisaHS commented 1 month ago

Maybe we could consider re-organizing the README - can the table of contents be moved to the top? Or have a mini TOC at the top that indicates there is a quickstart guide and a standard/full guide?

The issue I had is that I didn't realize there was a full guide down the page. I just started from the top of the page, troubleshooted some issues, then later realized there's a full guide at the bottom I should've been following instead. :blush: