search

canonical / sphinx-docs-starter-pack

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

Restructure admin and user information #165

Closed pmatulis closed 7 months ago

pmatulis commented 7 months ago

Make the readme be a landing page that describes the project and offers two paths for the user. Create two pages:

Keep the existing content as intact as possible by moving sections to the appropriate page. Content modifications include:

  1. The top of both new pages needed some work.
  2. A small section on building was added to help-enable.
  3. The headings' underlining needed to be changed throughout help-enable.

A subsequent PR will improve the wording of both new pages and the index page.

pmatulis commented 7 months ago

As discussed out of band, we will stick to a monolithic README, separate initialisation tasks from user tasks, and insert a table of contents. Then TOC will make it evident what the README contains and more navigable for GH users (but will be redundant when rendered locally due to the Furo theme's built-in TOC). This implies moving the already refactored help-woke.rst page back into the README.

pmatulis commented 7 months ago

fixes #96