← Back to issue list

docs: clarify external documentation support and update example URL

View original Github issue

Metadata

Project
charmcraft
Number
#2704
Type
pull request
State
merged
Author
danielvnguyen
Labels
Created
Updated
Closed

Current evaluation

Merged documentation update clarifying Charmhub's external documentation support and replacing an outdated Traefik example URL. Resolves ISD-5245. Approved by three reviewers and passed CI checks.

Suggested action:

No scores available.

Issue body

Updated the 'Add docs' section in the Manage Charms page to clarify Charmhub's support for external documentation sites and replaced the outdated Traefik example URL. Resolves [ISD-5245](https://warthogs.atlassian.net/browse/ISD-5245). --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/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`. - [x] I've added or updated any relevant documentation. - [x] 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. - [x] I've updated the relevant release notes. [ISD-5245]: https://warthogs.atlassian.net/browse/ISD-5245?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged documentation update clarifying Charmhub's external documentation support and replacing an outdated Traefik example URL. Resolves ISD-5245. Approved by three reviewers and passed CI checks.
qwen3.6-35b-a3b-mtp-q6
Staleness: 25
Complexity: 5
Confidence: 90
needs review Updates documentation to clarify Charmhub's external doc support and replaces an outdated Traefik example URL. Awaiting maintainer review after contributor ping.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#2453 docs: update link to public listing review process charmcraft merged Merged documentation update replacing the outdated Charmhub public listing review link with current Ops instructions. Approved by two reviewers, passed CI checks, and applied to a single file.
72%
#983 docs: update links rockcraft merged Merged documentation update that replaces hardcoded URLs with intersphinx and Sphinx references, and fixes redirected external links. Approved by three reviewers and passed CI checks after resolving initial lint and test failures.
71%
#2262 docs: hotfix for links syntax for charm docs examples charmcraft merged Merged following approval by three reviewers. The change corrected link syntax in the Manage charms documentation and added a Charmhub Discourse link. All required CI checks passed before integration.
70%
#288 docs: consolidate external links rockcraft merged Merged documentation update consolidating external links. Approved by two reviewers, passed CI checks, and modified six files with 19 additions and 12 deletions.
70%
#296 docs: fix bad link imagecraft merged Merged a one-line documentation update correcting a broken link in the security policy. Approved by two reviewers, the change passed all CI checks except spread tests, which did not block the merge.
70%
#945 docs: update docs with extra ref anchors craft-parts merged Merged documentation update adding extra reference anchors to support PR #2050. Approved by two reviewers, passed CI checks, and includes a changelog entry.
70%