← Back to issue list

doc: use the Pebble docs

View original Github issue

Metadata

Project
rockcraft
Number
#737
Type
issue
State
open
Author
cjdcordeiro
Labels
Type: Documentation
Created
Updated
Closed

Current evaluation

Doc improvement to reshape the Pebble explanation page to rely on official Pebble docs. Intersphinx mapping updated to new Pebble docs URL, but the page's main Pebble link still points to GitHub and the page hasn't been reshaped.

Suggested action: keep open

Reason: The intersphinx mapping was updated to point to https://ubuntu.com/docs/pebble (PR #1274), partially addressing the issue, but the main 'Pebble' link in docs/explanation/pebble.rst still points to https://github.com/canonical/pebble and the page hasn't been reshaped to rely more on the Pebble docs as requested. A maintainer comment 283 days ago reinforced the need to redirect users to the docs rather than the GitHub repo.

Impact: 30 Quick Win: 22.5 Staleness: 55 Complexity: 25 Confidence: 72 Support Request: 5

Issue body

Pebble now has docs: https://canonical-pebble.readthedocs-hosted.com/en/latest/ Let's reshape this page to rely more on the information from those docs. --- Document: explanation/pebble.rst

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 30
Quick Win: 22.5
Staleness: 55
Complexity: 25
Confidence: 72
Support Request: 5
keep open Doc improvement to reshape the Pebble explanation page to rely on official Pebble docs. Intersphinx mapping updated to new Pebble docs URL, but the page's main Pebble link still points to GitHub and the page hasn't been reshaped.
qwen/qwen3.6-35b-a3b
Staleness: 75
Complexity: 15
Confidence: 80
Support Request: 0
keep open Update explanation/pebble.rst to link to official Pebble documentation instead of the GitHub repo. Task is clearly scoped but has been inactive for over 200 days.
qwen3.6-35b-a3b-mtp-q6
Staleness: 65
Complexity: 15
Confidence: 85
Support Request: 0
keep open Documentation update to redirect Pebble references to official docs instead of GitHub repo. Currently awaiting implementation after maintainer request and recent contributor comment.
qwen3.6-35b-a3b-mtp-q6
Staleness: 70
Complexity: 15
Confidence: 85
Support Request: 0
keep open Documentation update to redirect users from the GitHub repo to the official Pebble documentation and align the explanation page with the new docs. Currently awaiting implementation.
qwen3.6-35b-a3b-mtp-q6
Staleness: 65
Complexity: 10
Confidence: 85
Support Request: 0
keep open Update the Pebble explanation page to link to the official Pebble documentation instead of the GitHub repository. The documentation update remains open and waiting to be implemented, with recent comments confirming the redirect change.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/rockcraft#1274 (confidence 80%)

    Updated intersphinx paths including the Pebble docs URL to https://ubuntu.com/docs/pebble, partially addressing this issue's goal of pointing to the official Pebble docs.

Related issues

Issue Project State Summary Similarity
#1058 docs: referencing Pebble documentation rockcraft open Updates the Pebble link in docs/explanation/pebble.rst from the GitHub repo to the official Pebble documentation page, plus minor spelling fixes. 2-line change, unreviewed, CI mostly green with one unrelated snap-tests failure.
79%
#847 docs: update pebble page and add references to pebble docs rockcraft open Docs-only PR updating the Pebble explanation page to reference official Pebble docs and cross-linking Pebble mentions on other pages (7 files, +21/-20). Review requested changes 263 days ago; author never responded; same goal pursued in newer PR #1058.
76%
#327 docs: rewrite the explanation section rockcraft merged Merged documentation rewrite detailing Pebble, chisel, rocks, and overlay-step explanations. Resolved issues #337 and #348 and corrected broken documentation header styling.
74%