canonical / sphinx-docs-starter-pack

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

readme.rst improvements: Quickstart guide #186

Closed degville closed 6 months ago

degville commented 6 months ago

The motivation for this is help people get up and running to test the Starter pack as quickly as possible, without having to skip through what's currently a large body of text.

degville commented 6 months ago

LGTM

Suggested next steps:

  • dial down echoing, which is neat but probably confusing

Thanks. I think you're right. I'll replace these elements after it's been merged.

  • alpha-docs > <new-repository-name> (or somesuch)

Yep, ok - thanks. I chose this as it's used later on in the readme.

degville commented 6 months ago

Thanks @ru-fu. I'll include all your suggestions in a follow-up. I'll put this together quickly, along with Daniele's suggestions.