← Back to issue list

docs: rename 'about this doc' → 'contribute to this doc'

View original Github issue

Metadata

Project
charmcraft
Number
#2400
Type
pull request
State
merged
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

Merged docs rename of the 'About this doc' page to 'Contribute to this doc' in commit 0f005502 (PR #2400), changing the page title and reference label in docs/about-this-documentation.rst.

Resolution: closed resolved

Reason: PR #2400 by maintainer medubelko was approved by two reviewers and merged as commit 0f005502, renaming the docs page title and Sphinx label; the file now reads 'Contribute to this documentation'. No redirect was added because the doc was not yet public, so no superseding work was needed.

Evaluated by: mr-cal-bot

No scores available.

Issue body

The title is a stakeholder requirement. I didn't create a redirect, because the doc isn't public yet.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged docs rename of the 'About this doc' page to 'Contribute to this doc' in commit 0f005502 (PR #2400), changing the page title and reference label in docs/about-this-documentation.rst.
stealth/space-bunny-alpha — closed resolved Merged snapcraft#5656, renaming “About this doc” to “Contribute to this doc” per stakeholder requirements. No redirect was added because the documentation is not yet public.
qwen/qwen3.6-35b-a3b — — Merged documentation update renaming about this doc to contribute to this doc per stakeholder requirements. Approved by two reviewers, passed CI checks, and modified two files. No redirect added since the doc is not public.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation changes renaming the heading from 'about this doc' to 'contribute to this doc' per stakeholder requirements. No URL redirect was created since the documentation remains unpublished.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/charmcraft#2377 (confidence 55%)

    Merged PR that originally added the 'about this documentation' page that #2400 renamed.

  • Related To: canonical/charmcraft#2594 (confidence 25%)

    Later commit (6264ff78) further updated the same docs/contribute-to-this-documentation.rst file (canonical starter pack 1.5).

Related issues

Issue Project State Summary Similarity
#930 docs: rename 'about this doc' → 'contribute to this doc' rockcraft merged Merged PR #930 renamed the documentation heading “About this doc” to “Contribute to this doc” in commit 6faa8365, satisfying the stakeholder requirement.
90%
#5656 docs: rename 'about this doc' → 'contribute to this doc' snapcraft merged Merged as commit 297667abf, renaming “About this doc” to “Contribute to this doc” in two files at stakeholder request.
85%
#187 docs: rename 'about this doc' → 'contribute to this doc' imagecraft merged Merged canonical/imagecraft#187 (6544d90), renaming “About this doc” to “Contribute to this doc” per stakeholder requirements; no redirect was added because the docs were not yet public.
82%
#2377 docs: add 'about this documentation' charmcraft merged Merged documentation updates adding an “about this documentation” section across three files in commit d979c757 (PR #2377).
74%
#920 docs: add 'about this documentation' rockcraft merged Merged documentation PR #920 in commit 8c27245c, adding an “About this documentation” section and updating three documentation files.
73%
#502 docs: add 'about this documentation' starbase merged Merged into main via commit 80e67c9, adding the mandatory 'About this documentation' page and related links.
71%
#6085 docs: add contribution section, revise explanations snapcraft merged Docs PR merged as commit 38038b106: added docs/contribute/ (index, development, documentation), docs/about-documentation.rst and a second toctree; CONTRIBUTING.md was kept. Follow-ups: #6105, #6107.
71%