Docs: Rebase against newer starter pack
Metadata
Current evaluation
Docs maintenance task to rebase against newer RTD starter pack; appears completed by commit 6264ff78 updating the canonical starter pack to 1.5.
Suggested action: close resolved
Reason: Commit 6264ff78 'build(docs)!: update canonical starter pack to 1.5 (#2594)' performed the requested rebase, and current docs/requirements.txt uses canonical-sphinx~=0.6 with Vale dependencies while docs/Makefile exposes vale targets, matching the newer modular starter pack described in the issue.
Evaluated by: mr-cal-bot
Impact:
30
Quick Win:
13
Complexity:
40
Confidence:
85
Actionability:
70
Issue body
### What needs to get done
- Once the starter pack improvements are complete, rebase the docs against it.
- Correct any warnings or errors in the docs resulting from the new tests.
### Why it needs to get done
We're using an old version of the RTD starter pack. The latest version is more modular, relying on extensions over bespoke configuration code, and will remove issues related to dependency management. It also provides testing with Vale, so we’re missing out on checks for basic style adherence. The documentation team is also developing additional tests and analytics that will land at the end of this cycle.
We should rebase so the docs benefit from these developments.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| ~deepseek/deepseek-pro-latest |
Impact:
30
Quick Win:
13
Complexity:
40
Confidence:
85
Actionability:
70
|
close resolved | Docs maintenance task to rebase against newer RTD starter pack; appears completed by commit 6264ff78 updating the canonical starter pack to 1.5. | |
| stealth/space-bunny-alpha |
Impact:
45
Quick Win:
18
Complexity:
55
Confidence:
97
Actionability:
90
|
close resolved | Docs were rebased onto Canonical Starter Pack 1.5 by merged PR #2594 (6264ff78); Vale and its docs checks are now present, completing the requested migration. | |
| stealth/space-bunny-alpha |
Impact:
40
Quick Win:
14
Complexity:
58
Confidence:
96
Actionability:
84
|
close resolved | Docs were rebased onto Canonical Starter Pack 1.5 by merged PR #2594; the repository now has the updated Sphinx stack and Vale dependencies, but #1926 remains open. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
19
Complexity:
20
Confidence:
90
Actionability:
80
|
close resolved | Request to rebase charmcraft documentation against the newer RTD starter pack to benefit from modular configuration, Vale style checks, and updated dependency management. | |
| qwen/qwen3.8-27b |
Impact:
35
Quick Win:
21
Staleness:
70
Complexity:
40
Confidence:
75
Support Request:
0
|
close stale | Task to rebase Charmcraft docs onto the newer, modular Canonical RTD starter pack (adding Vale style checks). The rebase was completed via PR #2594 (starter pack 1.5); docs now use extension-based config with Vale in requirements and Makefile. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
90
Complexity:
25
Confidence:
85
Support Request:
5
|
needs triage | Documentation needs rebasing to a newer RTD starter pack to improve modularity, dependency management, and add Vale style checks. Currently inactive with no maintainer triage or implementation progress. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
15
Confidence:
80
Support Request:
5
|
close stale | Documentation maintenance task to rebase against a newer ReadTheDocs starter pack for improved modularity and testing. Inactive for over a year with no maintainer response. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
20
Confidence:
70
Support Request:
0
|
close stale | Documentation maintenance task to rebase against a newer RTD starter pack. Unlabelled and inactive for over a year with only an automated Jira sync comment, showing no maintainer assessment or progress. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
charmcraft#2594
(confidence 90%)
Commit 6264ff78 updates the canonical starter pack to 1.5, directly addressing the requested rebase.
-
Related To:
snapcraft#6037
(confidence 85%)
Merged PR refreshing the docs starter pack implementation in snapcraft, part of the same cross-project effort.
-
Related To:
starbase#499
(confidence 85%)
Merged PR upgrading Starter Pack to 1.5 in starbase, the shared base for these docs changes.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #718 Docs: Rebase against newer starter pack | rockcraft | closed | Closed in favor of internal ticket CRAFT-3492; PR #1112 separately refreshed the docs starter pack in commit 61e6bf3a. | |
| #5071 Docs: Rebase against newer starter pack | snapcraft | closed | Closed in favor of internal CRAFT-3492; the associated starter-pack documentation refresh was later merged as canonical/charmcraft#6037. | |
| #1482 build(docs): refresh starter pack implementation | craft-parts | merged | Maintainer medubelko merged PR #1482 bumping the docs to Starter Pack 1.4.0 (+1371/-1094 across 35 files), resolving the `details` directive issue #1454 and CRAFT-5015. | |
| #499 build(docs): upgrade Starter Pack to 1.5 | starbase | merged | Merged canonical/starbase#499 in commit 8c01792, upgrading the documentation Starter Pack from 1.3.1 to 1.5 for CRAFT-5035. | |
| #1112 build(docs): refresh starter pack implementation | rockcraft | merged | Merged in PR #1112 via commit 61e6bf3a, refreshing the docs starter pack, adding a wordlist, local docs-auto serving, and docs-lint coverage. | |
| #2594 build(docs)!: update canonical starter pack to 1.5 | charmcraft | merged | Merged #2594 as 6264ff78, updating the Canonical Starter Pack to 1.5 and correcting the “Contribute to this page” icon/link issue tracked in #2558. | |
| #6037 build(docs): refresh starter pack implementation | snapcraft | merged | Merged PR #6037 (commit 4ee7c7e9f) refreshed Snapcraft's documentation starter pack to 1.4.0 across 73 files, resolving #5071; approvals and all CI checks passed. | |
| #24 Set up docs publishing on RTD | imagecraft | merged | Merged #24, adopting Canonical's Docs Starter Pack for Read the Docs and replacing the tox-based documentation build and checks. | |
| #135 docs: use Canonical starter pack | starbase | closed | Canonical Starter Pack adoption was completed by merged PR #478 (commit e94f190), updating the docs build and adding Make passthrough targets. |