Docs: Rebase against newer starter pack
Metadata
Current evaluation
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.
Suggested action: close stale
Reason: The core ask is done: commit 6264ff78 'build(docs)!: update canonical starter pack to 1.5 (#2594)' was merged, and the current docs/requirements.txt now lists the modular extensions (myst-parser, sphinx-tabs, etc.) plus Vale, with a `make vale` target in docs/Makefile — exactly the modular, Vale-enabled setup the issue requested. The issue is inactive (last activity 381 days ago) and the feature was implemented, so it no longer needs to stay open.
Impact:
35
Quick Win:
21.0
Staleness:
70
Complexity:
40
Confidence:
75
Support Request:
0
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 |
|---|---|---|---|---|
| qwen/qwen3.8-27b |
Impact:
35
Quick Win:
21.0
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. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
20
Confidence:
75
Support Request:
0
|
close stale | Rebase documentation on a newer Read the Docs starter pack to improve modularity, fix dependency issues, and enable Vale style checks. Open and waiting to be assigned after syncing to Jira. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
charmcraft#2594
(confidence 80%)
Merged PR 'build(docs)!: update canonical starter pack to 1.5' performs the rebase to the newer modular starter pack and adds Vale, matching the issue's goals.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #718 Docs: Rebase against newer starter pack | rockcraft | closed | Closed in favor of internal Jira ticket CRAFT-3492. The documentation rebase against the newer RTD starter pack will be tracked and completed via internal workflows instead of public GitHub. | |
| #104 feat(docs): use canonical starter pack | craft-store | merged | Merged documentation update to adopt the canonical starter pack, resolving craft-store#100 and CRAFT-2077. The change modifies 15 files with 502 additions and 63 deletions, approved by one reviewer. | |
| #1112 build(docs): refresh starter pack implementation | rockcraft | merged | Merged an external contribution refreshing the documentation starter pack. The update integrates the latest upstream pack, adds a project-specific wordlist, and documents new make commands for building and linting. Approved by two reviewers and passed CI checks. | |
| #2594 build(docs)!: update canonical starter pack to 1.5 | charmcraft | merged | Merged after two approvals. Updates the canonical starter pack to version 1.5 and resolves issue #2558. Required CI checks passed. Author noted pending fixes for substitution extension and Git lastmods will be handled separately. | |
| #1482 build(docs): refresh starter pack implementation | craft-parts | merged | Merged update refreshing the starter pack implementation to version 1.4.0. Resolves #1454 and fixes CRAFT-5015. The change modifies 35 files, passes all CI checks, and received dual reviewer approval before being merged. |