← Back to issue list

docs: group plugins by language

View original Github issue

Metadata

Project
craft-parts
Number
#1650
Type
pull request
State
open
Author
GreyViperTooth
Labels
Created
Updated
Closed

Current evaluation

Groups plugins by language in docs/reference/plugins.rst. Simplified per maintainer feedback to docs-only change. Waiting for second reviewer (medubelko) to assess fit with ongoing docs changes.

Suggested action: needs review

Reason: The PR was simplified per maintainer @steinbro's feedback to a docs-only change (dropping source reorganization). @steinbro looped in @medubelko on 2026-07-22 to assess how this fits with other ongoing docs changes. It is awaiting that second reviewer's input before proceeding.

Impact: 25 Quick Win: 21.25 Staleness: 45 Complexity: 15 Confidence: 75

Issue body

Group plugins by the language or technology they support, in both the documentation and the source tree. **Documentation** (first commit): the plugins reference index is organized into nine groups — Built-in, Multi-language, .NET, Go, Java, JavaScript, Python, Ruby, and Rust — each with a short description, instead of one flat alphabetical list. Page URLs are unchanged. **Source** (second commit): plugin modules move into per-language subpackages that mirror the documentation groups (for example `craft_parts/plugins/python/python_plugin.py`). Every previous module path remains importable through a compatibility alias module with explicit re-exports, so applications that do `from craft_parts.plugins import python_plugin` (as Snapcraft and Rockcraft do) are unaffected. A new unit test (`tests/unit/plugins/test_module_aliases.py`) checks for that guarantee. The `python_v2` package is already grouped and stays where it is. This change was developed with the assistance of an AI tool (Claude Fable 5). I have reviewed and tested all of it before making the commits. Fixes #1571

Evaluation history

Date Model Scores Action Summary
qwen3.6-35b-a3b-mtp-q6
Impact: 25
Quick Win: 21.25
Staleness: 45
Complexity: 15
Confidence: 75
needs review Groups plugins by language in docs/reference/plugins.rst. Simplified per maintainer feedback to docs-only change. Waiting for second reviewer (medubelko) to assess fit with ongoing docs changes.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 10
Confidence: 90
needs review Organizes plugin documentation by language to improve navigation. Maintainer requested dropping source reorganization; PR now contains only docs changes. Awaiting maintainer review.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 10
Confidence: 90
needs review Groups plugins by language in the documentation index. Maintainer requested dropping source reorganization; author updated branch to only include docs changes. Awaiting maintainer review.
qwen3.6-35b-a3b-mtp-q6
Staleness: 5
Complexity: 45
Confidence: 85
needs review Refactors plugin modules into language-specific subpackages and reorganizes documentation. Maintains backward compatibility via re-export aliases. Currently awaiting maintainer review with no comments or activity yet.

Update history

Date Change
updated
updated
updated
updated

Related work

  • Related To: craft-parts#1571 (confidence 95%)

    This PR addresses issue #1571 which requested grouping plugins by language/ecosystem in documentation.

Related issues

Issue Project State Summary Similarity
#1571 Group related plugins craft-parts open Group plugins by language/ecosystem in docs and source code. Maintainer confirmed proposed groupings; contributor committed to a PR but none has been filed. Docs toctree remains a flat alphabetical list.
72%