canonical/open-documentation-academy

Robotics: reformat the home page organization section

Aperta

#358 aperta il 22 lug 2026

 (5 commenti) (0 reazioni) (1 assegnatario)Python (99 fork)auto 404
good first issuesize 1

Metriche repository

Star
 (119 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

The mentor for this issue is @geoffreynyaga

Background

  1. The How this documentation is organized section on the Robotics Documentation home page is displayed as a card-style table. This interrupts the page layout. Reformat the section as a list, following these documentation home-page examples:
  1. The heading (i.e How this documentation is organized) should also be a level-2 heading.

Prerequisites

Basic familiarity with reStructuredText (reST) and Git is required.

What you will learn

  • How to edit reST source files.
  • How Canonical documentation home pages are structured.
  • How to contribute a documentation change through Git and GitHub.

Task

  1. In the canonical/robotics_documentation repository, update docs/index.rst.
  2. Replace the card-style list-table under How this documentation is organized with a list view.
  3. Change How this documentation is organized to a level-2 heading.
  4. Use the linked Multipass and Anbox Cloud pages as formatting references.
  5. Open a pull request against the repository and sign the Canonical contributor license agreement.

Outcome

The Robotics Documentation home page displays its documentation types in a readable list, and the section heading is level 2.

Resources

Guida contributor