search

canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
Other
15 stars 37 forks source link

Update documentation #254

Closed ru-fu closed 1 month ago

ru-fu commented 2 months ago

This PR updates the documentation for the new starter pack.

AnneCYH commented 1 month ago

Hey @ru-fu , thanks for the PR, massive effort and much needed! I appreciate the actual RST files in the starter pack which makes it easier for users to work off the starter pack. I had to copy-paste example files from other repos when I previously initialised a new docs repo :)

I left a few comments but nothing major.

Thanks!

ru-fu commented 1 month ago

Looks great. I would only say (non-blocking, suggestion) that most engineers I work with are more likely to look at the README than the linked documentation site - so it might be a good idea to add a specific link to the top of the README.

Good catch - I had completely forgotten about the readme. Added!