canonical/open-documentation-academy
Robotics: move the reference architecture page to Explanation
Open
#359 opened on Jul 22, 2026
diátaxisgood first issuesize 1
Repository metrics
- Stars
- (119 stars)
- PR merge metrics
- (PR metrics pending)
Description
The mentor for this issue is @geoffreynyaga
Background
The Reference architecture page explains how parts of the Canonical Robotics stack fit together. Despite its name, it is explanatory content rather than reference material, so it belongs in the Explanation section under the Diátaxis documentation framework.
Prerequisites
Basic Git and Markdown knowledge is required. Familiarity with Sphinx documentation is helpful.
Task
- In the
canonical/robotics_documentationrepository, movedocs/references/ref_architecture/reference_architecture.mdto the Explanation section. Move its image with it as well. - Remove the page from
docs/references/index.mdand add it todocs/explanations/index.md. - Update the home-page link in
docs/index.rstand any other internal links to use the new path. - Add a redirect in
docs/conf.pyfrom the old URL to the new URL so existing links do not break. - Run
make cleanandmake linkcheck; both commands must pass. - Open a pull request against the repository and sign the Canonical contributor license agreement.
Outcome
The Reference architecture page appears under Explanation, no longer appears under Reference, and the former URL redirects to its new location. Internal links and link checking pass.