← Back to issue list

docs: app title isn't read in TOC

View original Github issue

Metadata

Project
starbase
Number
#532
Type
issue
State
open
Author
medubelko
Labels
Type: Documentation Type: Bug
Created
Updated
Closed
—

Current evaluation

Rockcraft’s RTD/TOC title lacked its version; Starbase fixes #588 and #590 now format versioned docs titles and remove the html_title override.

Suggested action: close resolved

Reason: Merged commit 23328cd (PR #588) fixed version selection for docs titles: local, PR, and branch builds use major.minor while latest uses dev. Follow-up commit 9c0cd87 (PR #590) removed the html_title override, allowing the corrected default title to render.

Evaluated by: mr-cal-bot

Impact: 30 Quick Win: 14 Complexity: 35 Confidence: 97 Actionability: 72

Issue body

## Situation In Rockcraft, the title in the TOC isn't reading the Git tag: <img width="25%" alt="Image" src="https://github.com/user-attachments/assets/6060099e-503a-40ac-b71d-4141649d88d1" /> The code falls back to `dev` only if the Python env can't find `snapcraft.__version__`. In the RTD runner, that value isn't available for unknown reasons. ## Request - Find out why the RTD env can't access a copy of the Rockcraft source. - Patch the problem if it's on the Starbase side.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 30
Quick Win: 14
Complexity: 35
Confidence: 97
Actionability: 72
close resolved Rockcraft’s RTD/TOC title lacked its version; Starbase fixes #588 and #590 now format versioned docs titles and remove the html_title override.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 13
Complexity: 40
Confidence: 60
Actionability: 70
keep open Rockcraft docs TOC title shows 'dev' instead of Git tag because RTD environment can't access snapcraft.__version__. Open 136 days with no comments.
qwen/qwen3.8-27b
Impact: 30
Quick Win: 16
Staleness: 55
Complexity: 45
Confidence: 55
Support Request: 10
needs triage Rockcraft docs TOC title falls back to 'dev' instead of the Git tag because the RTD runner can't resolve the package version. Filed by a maintainer with no comments; related version/title fixes (#588, #590) landed since.
qwen/qwen3.6-35b-a3b
Staleness: 60
Complexity: 30
Confidence: 85
Support Request: 10
needs triage Documentation build fails to read Git tag for app title in RTD environment, falling back to dev. Lacks maintainer response or assignment after 74 days.
qwen3.6-35b-a3b-mtp-q6
Staleness: 65
Complexity: 15
Confidence: 90
Support Request: 0
needs triage Documentation build fails to read Git tag for app title in TOC due to missing version info in ReadTheDocs environment. Open for 61 days with no maintainer response or activity.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/starbase#588 (confidence 98%)

    Merged fix explicitly corrected version selection in documentation titles.

  • Likely Fixed By: canonical/starbase#590 (confidence 97%)

    Merged follow-up removed the html_title override that could mask the corrected title behavior.

Related issues

Issue Project State Summary Similarity
#775 docs: apply release-notes template to rockcraft rockcraft merged Merged #775 in commit 89aad735, rendering Starbase's release-notes template for Rockcraft and adding 257 lines across three documentation files.
70%