Documentation is missing important concepts and graphs

Metadata

Project: craft-parts
Number: #583
Type: issue
State: open
Author: sergiusens
Labels: —
Created: 2023-11-20 02:17 PM UTC
Updated: 2025-03-11 02:28 PM UTC
Closed: —

Current evaluation

Maintainer-filed docs gap report (2024): the overlays and lifecycle explanation pages reportedly lack key concepts and diagrams. Only screenshots plus two readthedocs links; no labels, no maintainer triage, only a Jira bot comment.

Suggested action: needs triage

Reason: The issue has no labels, no assignee, and the only comment is the autogenerated 'internal ticket has been created: CRAFT-2944' message from @syncronize-issues-to-jira[bot] — there is no maintainer assessment, so it still needs triage. The body contains only two screenshots and links to the overlays and lifecycle explanation pages, with 'n/a' for repro/logs, so which specific concepts or graphs are missing cannot be determined from the text; I could only confirm the pages now exist and already include /common/craft-parts/images/overlay_checksum.svg and lifecycle_logic.png (see docs/common/craft-parts/explanation/overlays.rst and lifecycle.rst), meaning the requested diagrams may have been added by later docs work (#688 shared-docs rework, #1273, #1453) but the specific gaps remain unverified.

Evaluated by: mr-cal-bot

Impact: 40 Quick Win: 8 Complexity: 30 Confidence: 62 Actionability: 28

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
2026-10-02 06:26 PM UTC	stealth/space-bunny-alpha	Impact: 40 Quick Win: 8 Complexity: 30 Confidence: 62 Actionability: 28	needs triage	Maintainer-filed docs gap report (2024): the overlays and lifecycle explanation pages reportedly lack key concepts and diagrams. Only screenshots plus two readthedocs links; no labels, no maintainer triage, only a Jira bot comment.
2026-10-02 02:03 AM UTC	qwen/qwen3.8-27b	Impact: 30 Quick Win: 4 Complexity: 40 Confidence: 45 Actionability: 25	needs triage	Docs for overlays and lifecycle pages reportedly missing important concepts and graphs (per screenshots). No labels, no maintainer triage, only a Jira bot comment. Docs have been updated since filing but specific gaps unconfirmed.
2026-09-22 10:24 AM UTC	qwen/qwen3.6-35b-a3b	Impact: 30 Quick Win: 16 Complexity: 10 Confidence: 80 Actionability: 60	needs triage	Documentation gap in craft-parts regarding overlays and lifecycle concepts, lacking explanatory graphs. Open, unlabelled, awaiting maintainer triage.
2026-09-01 06:24 AM UTC	qwen/qwen3.8-27b	Impact: 40 Quick Win: 26 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.
2026-07-22 01:24 PM UTC	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.
2026-07-09 11:18 AM UTC	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.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.