search

canonical / real-time-ubuntu-docs

Real-time Ubuntu documentation
https://documentation.ubuntu.com/real-time
0 stars 1 forks source link

Structural improvements to home and index pages #40

Closed AnneCYH closed 1 month ago

AnneCYH commented 1 month ago

This update is based on an internal review of the current RTU docs.

The changes addressed in this update:

  1. Home page / landing page Diataxis map description is more specific to RTU docs to provide better context on what to expect.
  2. Provide context about the categories of how-to guides that are available to help users with RTU.
  3. Remove "intro" for the Reference section; not necessary.
  4. Move "Supported releases" to the bottom since that is about supported Ubuntu versions and not so much about RTU features.
  5. Removed "section" for Explanation because the current docs only has a single Explanation document.

I did not update the tutorial as I think it would be better to discuss it first since grouping the content would require a significant amount of restructuring.

AnneCYH commented 1 month ago

Hi @farshidtz , I addressed the comments you had; lemme know if you have further feedback. Thank you!