Create a common documentation folder
Metadata
Current evaluation
Requests a shared docs folder for reuse by craft apps. Already implemented: docs/common ships as the craft_application_docs package, with README, how-to and reference pages, plus CONTRIBUTING.md guidance.
Suggested action: close resolved
Reason: The requested common documentation folder exists and is actively maintained. Commit 2c32b1ae ('docs: add remote build how-to and reference docs', PR #746) introduced docs/common/__init__.py and registered it in pyproject.toml as the packaged directory ("craft_application_docs" = "docs/common"), and docs/common/README.md now states the folder 'contains documentation files that are meant to be shared and reused by applications using Craft Application.' It is populated with how-to-guides (build-remotely, pack-a-pro-artifact, reuse-packages-between-builds) and reference (remote-builds, fetch-service, strict-platform-names) pages, with more added since (#920, #1023, #1144, #1185, #1202), and CONTRIBUTING.md documents 'For features inherited by downstream apps, place documentation in the common directory.' The motivating goal is met too: #412's environment variables reference was added in 1509cec9 (#431) and is listed in docs/reference/index.rst. Only a minor gap remains — environment-variables.rst sits under docs/reference rather than docs/common — which does not warrant keeping the tracking issue open.
Evaluated by: mr-cal-bot
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
15
Quick Win:
12
Complexity:
5
Confidence:
92
Actionability:
85
|
close resolved | Requests a shared docs folder for reuse by craft apps. Already implemented: docs/common ships as the craft_application_docs package, with README, how-to and reference pages, plus CONTRIBUTING.md guidance. | |
| stealth/space-bunny-alpha |
Impact:
30
Quick Win:
14
Complexity:
25
Confidence:
82
Actionability:
60
|
close resolved | Request for a shared/common docs folder reusable by applications (like craft-parts). That structure now exists at docs/common/ with a README on substitution and is actively maintained, so the request is effectively delivered. | |
| qwen/qwen3.6-35b-a3b |
Impact:
0
Quick Win:
0
Complexity:
0
Confidence:
100
Actionability:
100
|
close resolved | The docs/common folder for shared documentation already exists and is actively maintained. | |
| qwen/qwen3.8-27b |
Impact:
40
Quick Win:
32
Staleness:
55
Complexity:
20
Confidence:
70
Support Request:
0
|
keep open | Request to create a common documentation folder (like craft-parts) for docs reusable across applications. The docs/common folder now exists with reusable docs and is referenced in CONTRIBUTING.md, so the core ask appears implemented. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
85
Complexity:
20
Confidence:
75
Support Request:
10
|
close stale | Request to create a shared documentation folder for reusable content like environment variables. Issue is inactive for over a year, lacks maintainer engagement, and appears to be a low-priority enhancement. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
20
Confidence:
75
Support Request:
10
|
close stale | Stale documentation enhancement requesting a shared docs folder for reusable content. No maintainer activity in nearly a year; likely deprioritized or superseded by current project structure. |
Update history
No update history recorded yet.
Related work
-
Related To:
craft-application#412
(confidence 95%)
Referenced in the issue body as the motivating example; closed via 1509cec9 (#431) which added the environment variables reference.
-
Likely Fixed By:
craft-application#746
(confidence 88%)
Commit 2c32b1ae created docs/common/__init__.py and the pyproject 'craft_application_docs' package-dir entry, satisfying the request.
Related issues
No related issues found above the similarity threshold.