docs: add content to how-to landing pages - #1316
Open
asanvaq wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Rockcraft’s “How-to” landing pages to better match the project’s landing-page model by adding missing meta descriptions and providing short, curated entry points into each how-to area.
Changes:
- Added/updated
.. meta:: :description:blocks for how-to landing pages that were missing or overly generic. - Expanded the Crafting and Chiseling landing pages with short overviews and curated
:ref:link lists, while hiding the underlying toctrees. - Added a brief introductory sentence to the Documentation landing page and normalized its toctree entries.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/how-to/index.rst | Adds a meta description for the how-to landing page. |
| docs/how-to/documentation/index.rst | Adds a short intro line and normalizes the toctree entry format. |
| docs/how-to/crafting/index.rst | Reworks the landing page into a modeled overview with curated links and a hidden toctree. |
| docs/how-to/chiseling/index.rst | Adds meta description and a curated overview with hidden toctree for chiseling how-tos. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
asanvaq
marked this pull request as ready for review
August 2, 2026 19:21
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.
The following landing pages in the how-to section do not fit the required model:
This PR updates them to fit the model. Metadata descriptions have also been added to those missing them.
make lint && make test.