docs: update how-to and reference landing pages#92
Closed
florentianayuwono wants to merge 1 commit into
Closed
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>
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