← Back to issue list

Support versioned doc urls

View original Github issue

Metadata

Project
craft-application
Number
#368
Type
issue
State
closed
Author
tigarmo
Labels
—
Created
Updated
Closed

Current evaluation

Implemented version-aware documentation URL rendering in merged PR #380 (commit 600cec0e), building on the base URL support introduced by #361.

Resolution: closed resolved

Reason: Merged PR #380 via commit 600cec0e added versioned documentation URL rendering and version-aware Emitter links. The PR explicitly resolves #368.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### What needs to get done PR #361 added support for a base URL for documentation links; we should improve this support to enable _versioned_ URLs. For example, this is currently hardcoded in Rockcraft as `https://documentation.ubuntu.com/rockcraft/en/stable`, but what we need to is have `https://documentation.ubuntu.com/rockcraft/en/<version>`, where `<version>` is either the actual version if it's a tagged commit, or `latest` otherwise for interim commits, pull requests, etc. ### Why it needs to get done To prevent link rot and have the application always link to the "most correct" docs.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Implemented version-aware documentation URL rendering in merged PR #380 (commit 600cec0e), building on the base URL support introduced by #361.
stealth/space-bunny-alpha — closed stale Versioned doc URLs were abandoned after 804 days of inactivity; only automated Jira ticket creation was recorded, with no implementation PR.
qwen/qwen3.6-35b-a3b — — Closed without implementation. The request to replace stable documentation links with dynamic versioned URLs was not addressed, indicating the feature was abandoned or deferred.
qwen/qwen3.6-35b-a3b — — Closed without implementation. The feature request for dynamic versioned documentation URLs was synced to Jira but never addressed or merged.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/craft-application#380 (confidence 100%)

    Merged PR implementing version rendering in documentation URLs and explicitly fixing this issue.

  • Related To: canonical/craft-application#361 (confidence 95%)

    Introduced the documentation base URL support that this issue sought to extend with version placeholders.

Related issues

Issue Project State Summary Similarity
#380 feat: render versions in doc urls craft-application merged Merged in #380 via commit 600cec0e, adding versioned documentation URL rendering and version-aware Emitter links; fixes #368.
77%
#634 feat: use versioned form of doc urls rockcraft merged Merged PR #634 updated Rockcraft error messages and init templates to use versioned documentation URLs, including the running version in links.
72%
#5901 docs: fix canonical URL snapcraft merged Merged PR #5901 (commit 02d84057a), updating docs to use RTD's versioned canonical URLs and omit generated pages from the sitemap.
71%