docs: distinguish between Charmhub-hosted libs and Python packages
Metadata
Current evaluation
Merged in commit 179d2553, clarifying Charmhub-hosted libraries versus Python packages, adding relevant guides and indexes, and limiting library command docs/help to Charmhub libraries.
Resolution: closed resolved
Reason: PR #2473 was merged as commit 179d2553. It updated the library documentation and command help and removed the redundant Popular libraries section.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in commit 179d2553, clarifying Charmhub-hosted libraries versus Python packages, adding relevant guides and indexes, and limiting library command docs/help to Charmhub libraries. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #2473 (commit 179d2553), clarifying that Charmhub-hosted charm libraries differ from Python packages, adding relevant documentation links, and updating library command help. | |
| 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. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1036 Expose libraries as pip installable packages | charmcraft | closed | Proposal to publish Charmhub-hosted libraries as pip packages was redirected to Charmhub while broader charm-library dependency management was reconsidered. |