docs: remove internal links in common directory
Metadata
Current evaluation
PR #1162 merged as commit 89d51b16: removed internal links from docs/common pages to avoid Sphinx build failures in downstream apps, plus keyword→key wording, .gitignore Sphinx artifacts, spelling/wordlist fixes.
Resolution: closed resolved
Reason: Maintainer medubelko's CRAFT-4646 PR was approved and merged into main via commit 89d51b16 ("docs: remove internal links in common directory"), implementing the rule that docs in the common directory must not link to Craft Parts pages; the changelog date was finalized so craft-parts could be released without a separate release PR.
Evaluated by: mr-cal-bot
No scores available.
Issue body
CRAFT-4646:
This completes the implementation of a rule where we won't make anything in the `common` doc directory link to pages within Craft Parts. We do this because we can't guarantee which Craft Parts pages downstream apps will use. If a used common page refers to an unused common page, the Sphinx build breaks.
Other:
- Replace instances of "keyword" with "key".
- Add other Sphinx artifacts to `.gitignore`.
- Fix spelling errors, add to wordlist.
---
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you added an entry to the changelog (`docs/reference/changelog.rst`)?
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | PR #1162 merged as commit 89d51b16: removed internal links from docs/common pages to avoid Sphinx build failures in downstream apps, plus keyword→key wording, .gitignore Sphinx artifacts, spelling/wordlist fixes. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/craft-parts#1162 via commit 89d51b16, removing internal links from common docs to prevent downstream Sphinx failures and applying minor documentation cleanups. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged after approval and CI checks. Removes internal links in the common docs directory to prevent Sphinx build failures in downstream apps. Also updates terminology, adds Sphinx artifacts to .gitignore, fixes spelling, and finalizes the changelog. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/craft-parts#1170
(confidence 25%)
Likely the follow-up 2.37.0 release that shipped the changelog finalized in this PR (unconfirmed).
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #288 docs: consolidate external links | rockcraft | merged | Docs-only cleanup merged: PR #288 by dboddie consolidated external links across six files (+19/-12), landing as commit babd81ea. | |
| #983 docs: update links | rockcraft | merged | Merged documentation cleanup that migrated Pebble links to intersphinx, converted internal links to Sphinx references, and refreshed redirected external URLs. | |
| #1063 docs: fix a missing link | rockcraft | merged | Merged PR #1063 fixed a missing documentation hyperlink in commit 8c4ab4a3; the one-line change was approved by four reviewers. | |
| #1250 Fixed links to doc | snapcraft | merged | Merged as commit c222df587 (docs: fixed links to doc), removing 3 stale README links left pointing at the doc/ folder deleted by #1227. |