docs: distinguish between Charmhub-hosted libs and Python packages
Metadata
Current evaluation
Merged documentation update distinguishing Charmhub-hosted and Python package charm libraries. Added explanatory links, removed redundant sections, and updated command help. Approved by reviewers and passed CI checks.
Suggested action: —
No scores available.
Issue body
This PR updates the charm library related docs to be clear about the difference between Charmhub-hosted charm libraries, and Python package charm libraries.
Where appropriate, links have been added to the `charmlibs` documentation site, to point readers to [an explanation of the different kinds of charm libraries](https://documentation.ubuntu.com/charmlibs/explanation/charm-libs/), and guidance for [managing non-Charmhub-hosted libs](https://documentation.ubuntu.com/charmlibs/how-to/manage-libraries/).
This PR also removes the 'Popular libraries' section from the `<libname>.py` page in favour of links to the [general](https://documentation.ubuntu.com/charmlibs/reference/general-libs/) and [interface](https://documentation.ubuntu.com/charmlibs/reference/interface-libs/) library indexes. This section was a helpful source when creating these indexes earlier this cycle, but is now redundant.
The library related command docs and help have been updated to be explicit about applying only the Charmhub-hosted libs. It would be neat to add links to docs here, but I don't think that will work with the command help.
Preview build links to changed Charmhub docs pages:
- [Manage libraries](https://canonical-ubuntu-documentation-library--2473.com.readthedocs.build/charmcraft/2473/howto/manage-libraries/)
- [`<libname>.py` file](https://canonical-ubuntu-documentation-library--2473.com.readthedocs.build/charmcraft/2473/reference/files/libname-py-file/)
- [`charmcraft.yaml` file > charm-libs](https://canonical-ubuntu-documentation-library--2473.com.readthedocs.build/charmcraft/2473/reference/files/charmcraft-yaml-file/#charm-libs)
- [create-lib](https://canonical-ubuntu-documentation-library--2473.com.readthedocs.build/charmcraft/2473/reference/commands/create-lib/)
- [fetch-libs](https://canonical-ubuntu-documentation-library--2473.com.readthedocs.build/charmcraft/2473/reference/commands/fetch-libs/)
- [list-lib](https://canonical-ubuntu-documentation-library--2473.com.readthedocs.build/charmcraft/2473/reference/commands/list-lib/)
- [publish-lib](https://canonical-ubuntu-documentation-library--2473.com.readthedocs.build/charmcraft/2473/reference/commands/publish-lib/)
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update distinguishing Charmhub-hosted and Python package charm libraries. Added explanatory links, removed redundant sections, and updated command help. Approved by reviewers and passed CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates clarifying the distinction between Charmhub-hosted libraries and Python packages. Added relevant links, removed the redundant popular libraries section, and updated command references to explicitly specify Charmhub-hosted scope. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates clarifying Charmhub-hosted versus Python package charm libraries. Changes add explanatory links, remove a redundant popular libraries section, and update command help to specify Charmhub-hosted scope. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2659 docs: remove charmhub config | charmcraft | merged | Merged into main. Documentation references to charmhub were removed while keeping the underlying code intact for backward compatibility. Closes issue 1787 after reviewer approval and CI validation. | |
| #2253 docs: add charm docs exemplars links | charmcraft | merged | Merged after approval and CI checks. Added links to charm documentation exemplars to improve guidance. Updated one file with 34 additions and 5 deletions as part of a documentation standardization initiative. | |
| #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. | |
| #872 docs: add anchors to support charmcraft documentation | craft-parts | merged | Merged. Added documentation anchors to Python and Poetry pages for Charmcraft support. Approved by two reviewers with passing CI and zero unresolved comments. | |
| #2240 docs: update charm definition in security doc | charmcraft | merged | Merged documentation update revising the charm definition in the security guide. Incorporated feedback from a prior discussion, approved by two reviewers, passed CI checks, and successfully merged with minimal line changes. | |
| #1967 docs: add howto guides for switching from the charm plugin | charmcraft | merged | Merged documentation adding how-to guides for migrating from the charm plugin to the python and poetry plugins. Review testing uncovered a default configuration bug, resolved separately in pull request 1972. |