canonical/open-documentation-academy
Robotics: reformat the home page organization section
开放
#358 创建于 2026年7月22日
good first issuesize 1
仓库指标
- 星标
- (119 个星标)
- PR 合并指标
- (平均合并 6天 22小时) (30 天内合并 2 个 PR)
描述
The mentor for this issue is @geoffreynyaga
Background
- 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:
- 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
- In the
canonical/robotics_documentationrepository, updatedocs/index.rst. - Replace the card-style
list-tableunder How this documentation is organized with a list view. - Change How this documentation is organized to a level-2 heading.
- Use the linked Multipass and Anbox Cloud pages as formatting references.
- 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.