← Back to issue list

fix(docs): update base docs_url to use stable

View original Github issue

Metadata

Project
snapcraft
Number
#6311
Type
pull request
State
closed
Author
Tejas-Raj01
Labels
—
Created
Updated
Closed

Current evaluation

Closed unmerged as a duplicate: canonical/craft-application#1140 fixed #6300 in commit 209a1367 by routing remote-build documentation through the major version.

Resolution: closed superseded

Reason: The change was already implemented by canonical/craft-application#1140, commit 209a1367, which closed the underlying Snapcraft #6300 bug before this PR was merged.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### Describe your changes. **Context:** When a remote build fails (or other framework-level errors occur), `craft-application` generates a documentation URL based on the application's base `docs_url`. Currently, this base URL is set to `https://documentation.ubuntu.com/snapcraft/{version}`. Because `{version}` resolves to strict patch versions (e.g., `9.0.0`), the generated URLs lead to 404 pages since the documentation site uses `stable` or major.minor routing (e.g., `9.0`). **Changes in this PR:** - Updated the root `docs_url` in `snapcraft/application.py` to use `stable` instead of `{version}`, bringing it in line with the rest of the hardcoded documentation URLs across the codebase and fixing broken links for users. Fixes #6300 --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [x] I've successfully run `make lint && make test`. - [ ] I've added or updated any relevant documentation. - [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [ ] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed superseded Closed unmerged as a duplicate: canonical/craft-application#1140 fixed #6300 in commit 209a1367 by routing remote-build documentation through the major version.
stealth/space-bunny-alpha — closed superseded Closed unmerged as duplicate: craft-application PR #1140 fixed the broken docs URLs in commit 209a1367 and closed Snapcraft #6300.
qwen/qwen3.6-35b-a3b — — Closed after reviewer coordination regarding issue assignment. The change updates the base documentation URL to use stable instead of patch versions, resolving broken links (issue #6300).

Update history

No update history recorded yet.

Related work

  • Related To: snapcraft#6300 (confidence 100%)

    This was the original broken remote-build documentation URL issue.

  • Superseded By: canonical/craft-application#1140 (confidence 99%)

    Its commit 209a1367 fixed the broken documentation routing upstream.

Related issues

Issue Project State Summary Similarity
#6300 Broken docs URL for remote build explanation snapcraft closed Remote-build doc links now use the major version (9.0 instead of 9.0.0), fixed by craft-application PR #1140 in commit 209a1367.
74%
#1341 fix: use major-version docs URLs in init output rockcraft open Updates craft-application to emit major-version documentation URLs, with regression and companion test/docs updates; later main already requires >=7.3.0 and contains these changes, making the PR obsolete.
71%
#931 fix(docs/changelog): switch to ISO 8601 dates craft-application merged Merged canonical/craft-application#931 in commit 977f28e4, standardizing 64 changelog date headings to ISO 8601 format.
71%