docs: update how-to and reference landing pages#93
Merged
florentianayuwono merged 6 commits intoMay 27, 2026
Conversation
- Remove meta-descriptions from all sections - Merge orphan 'Development' section into 'Maintenance and development' - Merge orphan 'Architecture and deployments' into 'Configuration and operations' in reference - Add visible bullet-list links and meaningful section descriptions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation landing pages for How-to and Reference to improve information scent and reduce meta/boilerplate descriptions, while regrouping pages into more cohesive sections.
Changes:
- Rewrites landing-page intro and section descriptions to be more subject-focused (less “this section contains…”).
- Restructures section groupings in both
how-toandreferenceindexes (merging previously orphaned single-page sections). - Reorders which pages appear under each heading (e.g., moving Charm architecture under “Configuration and operations”).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/reference/index.rst | Reworks reference landing-page text and reorganizes pages into “Configuration and operations” and “Connectivity and monitoring”. |
| docs/how-to/index.rst | Rewords how-to landing page and merges “Development” into “Maintenance and development”. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
erinecon
approved these changes
May 26, 2026
Contributor
erinecon
left a comment
There was a problem hiding this comment.
Thanks so much for implementing Daniele's feedback into the landing pages! I agree with all of Copilot's suggestions, and I added a nit + question for some potential follow-up work
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Erin Conley <erin.conley@canonical.com>
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
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.
What this PR does
Updates the how-to and reference landing pages to improve documentation quality.
Why we need it
Meta-descriptions add noise without value — readers can see what pages are listed. Orphan sections (single page under a heading) fragment the navigation unnecessarily. These changes follow the documentation standards demonstrated in the wordpress-k8s-operator docs.
Checklist
docs/changelog.mdwith user-relevant changes(e.g., in
.github/workflows/integration_tests.yaml, ensure themoduleslist is correct)terraform fmtpasses andtflintreports no errorsTest plan
Documentation-only change. Verified by reviewing the rendered RST structure: toctree entries are preserved, bullet links are correct, and no orphan sections remain.
Review focus