← Back to issue list

Documentation is missing important concepts and graphs

View original Github issue

Metadata

Project
craft-parts
Number
#583
Type
issue
State
open
Author
sergiusens
Labels
Created
Updated
Closed

Current evaluation

Docs gap: overlays and lifecycle explanation pages lack important concepts and diagrams (referenced images missing/broken). Open since 2022, only a Jira-sync bot comment; no maintainer response or labels.

Suggested action: needs triage

Reason: The issue is a self-filed documentation gap by a maintainer (sergiusens) with screenshots showing missing concepts/graphs on the overlays and lifecycle pages, but it has no labels, no assignee, and the only comment is the automated Jira-sync bot (CRAFT-2944) — no human triage has occurred. The referenced docs (docs/common/craft-parts/explanation/lifecycle.rst and overlays.rst) still exist and still reference the images (lifecycle_logic.png, overlay_checksum.svg), so the gap appears unresolved and the issue remains relevant, but it needs a maintainer to confirm scope and priority.

Impact: 40 Quick Win: 26.0 Staleness: 70 Complexity: 35 Confidence: 75 Support Request: 10

Issue body

### Bug Description ![image](https://github.com/canonical/craft-parts/assets/1146853/3d2e1bfc-9135-476e-9ee4-3742bd94fe0c) ![image](https://github.com/canonical/craft-parts/assets/1146853/07fa8a75-eab8-40b0-a999-cf8d88daa9af) ### To Reproduce Read the docs on - https://canonical-craft-parts.readthedocs-hosted.com/en/latest/explanation/overlays.html - https://canonical-craft-parts.readthedocs-hosted.com/en/latest/explanation/lifecycle.html#part-processing-order ### part yaml ```shell n/a ``` ### Relevant log output ```shell n/a ```

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 40
Quick Win: 26.0
Staleness: 70
Complexity: 35
Confidence: 75
Support Request: 10
needs triage Docs gap: overlays and lifecycle explanation pages lack important concepts and diagrams (referenced images missing/broken). Open since 2022, only a Jira-sync bot comment; no maintainer response or labels.
qwen/qwen3.6-35b-a3b
Staleness: 95
Complexity: 25
Confidence: 80
Support Request: 15
close stale Report on missing documentation concepts and graphs, opened over two years ago with no maintainer labels or follow-up.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 25
Confidence: 85
Support Request: 10
needs triage Documentation report highlighting missing concepts and diagrams in the overlays and lifecycle explanation pages. Open, unlabelled, with no maintainer response since a Jira sync bot comment over a year ago.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 20
Confidence: 75
Support Request: 10
close stale Documentation lacks critical concepts and diagrams for overlays and lifecycle processing. Open for over two years, last active 465 days ago. Synced to Jira CRAFT-2944. Awaiting documentation updates or assignment.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.