doc: update home page to new pattern - #1537
Open
elijahgreenstein wants to merge 2 commits into
Open
Conversation
elijahgreenstein
requested review from
mionaalex,
morphis,
mseralessandri and
roosterfish
September 3, 2026 21:10
elijahgreenstein
force-pushed
the
homepage-update
branch
2 times, most recently
from
September 3, 2026 22:23
e095aed to
cc87eda
Compare
Contributor
Author
|
An issue with the spellcheck tool is resulting in a failing spellcheck for the home page |
roosterfish
requested changes
Sep 4, 2026
- Reorganizes the home page domains of concern to align with documentation team standards - In the process, adds cross references to additional documentation pages - Introduces the `sphinx-structured-toc` extension, as per documentation team standards (requires a reStructuredText-formatted `index` page, rather than MyST Markdown) - Adds custom CSS to change "slice" separator color to Ubuntu orange Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
The upstream Vale settings need to be updated to ignore labels in a `ref` role in reStructuredText files. For now, I've turned Vale off around the problem ref role (`howto`), and this can be reversed after a fix comes in upstream on this issue: <canonical/documentation-style-guide#207> Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
elijahgreenstein
force-pushed
the
homepage-update
branch
from
September 4, 2026 15:19
2ff518c to
2424d78
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
sphinx-structured-tocextension, as per documentation team standards (requires a reStructuredText-formattedindexpage, rather than MyST Markdown)