← Back to issue list

docs: fix headings in 'Overlay step' explanation

View original Github issue

Metadata

Project
craft-parts
Number
#1453
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #1453 as commit b6d6d35b, fixing heading levels in docs/common/craft-parts/explanation/overlays.rst so top-level headings no longer leak into the explanation category ToC.

Resolution: closed resolved

Reason: The PR itself was merged into main by maintainer jahn-junior with one approving review and no unresolved comments, landing as commit b6d6d35b titled 'docs: fix headings in \'Overlay step\' explanation (#1453)'. The change demotes the headings in the 'Overlay step' explanation page to keep them out of the category ToC.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [X] Have you followed the guidelines for contributing? - [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? ~~Have you successfully run `make lint && make test`?~~ ~~Have you added an entry to the changelog (`docs/reference/changelog.rst`)~~ --- These top-level headings were appearing the explanation category ToC <img width="234" height="485" alt="image" src="https://github.com/user-attachments/assets/cde10bdc-d6ec-4b1e-9595-52a208d7d5e9" />

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #1453 as commit b6d6d35b, fixing heading levels in docs/common/craft-parts/explanation/overlays.rst so top-level headings no longer leak into the explanation category ToC.
stealth/space-bunny-alpha — closed resolved Merged PR #1453 as commit b6d6d35b, correcting heading levels in the “Overlay step” explanation so they no longer appear in the explanation-category ToC.
qwen/qwen3.6-35b-a3b — — Merged documentation fix correcting top-level headings in the 'Overlay step' explanation that incorrectly appeared in the Table of Contents. Approved by reviewer, passed CI checks, and integrated with minor changes to two files.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/craft-parts#1273 (confidence 60%)

    Earlier commit 731c8110 'docs: update headers to match style guide (#1273)' touched the same overlays.rst file, establishing the heading conventions this PR corrects.

Related issues

Issue Project State Summary Similarity
#370 docs: explanation section for overlays craft-parts merged Merged PR #370 as commit a90caeb4, adding overlay documentation and incorporating #365’s lifecycle changes; it resolved CRAFT-1560.
77%
#1049 docs(fix): adjust heading level in 'using parts' craft-parts merged Merged PR #1049 corrected the heading hierarchy in the "Using parts" how-to, unblocking downstream documentation ingestion; landed as c3104da1.
74%
#765 docs: fix explanation pages craft-parts merged Merged as 2ae355df, proofreading and updating Craft Parts and Rockcraft explanation pages; missing overlay labels were handled in follow-up #795.
73%
#327 docs: rewrite the explanation section rockcraft merged Merged as 0e36ee79, rewriting docs for Pebble, Chisel, rocks, and overlay steps while restoring header styling and resolving #337 and #348.
72%
#795 docs: add labels for overlay step craft-parts merged Merged in canonical/craft-parts#795 via commit 63145713, adding labels so overlay-step references remain valid when explanation pages are excluded.
72%