Docs: Rewrite `overlay` field description
Metadata
Current evaluation
Overlay field documentation was rewritten to fix typos, clarify exhaustive list behavior, and explain path negation syntax. The issue was closed after documentation updates clarifying example usage and negation behavior.
Suggested action: —
No scores available.
Issue body
## Situation
In canonical/rockcraft/pull/1041, we're transcluding the docs of the `overlay` key for the first time.
The key's documentation needs improvement and additional context:
https://github.com/canonical/craft-parts/blob/f2227aac531a1de6cf454081717c3256b2663462/craft_parts/parts.py#L387
## Request
- [ ] Fix "overly" typo.
- [ ] Remove "overlay filesystem" as a term, as it's unhelpful to users.
- [ ] Rewrite the description so that it informs how the user will use the key to productive effect:
- Describe what happens when the list is set at all. It's an _exhaustive_ list.
- Describe the path negation syntax.
- [ ] Review the second example. Why would `-etc/...` be needed when it automatically excludes everything that's not listed?
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Overlay field documentation was rewritten to fix typos, clarify exhaustive list behavior, and explain path negation syntax. The issue was closed after documentation updates clarifying example usage and negation behavior. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed and tracked via internal Jira ticket for documentation updates. The overlay field description was slated for rewriting to fix typos, clarify usage, and correct examples. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed without resolution. Documentation improvements for the overlay field were requested, including typo fixes, usage explanations, and negation syntax clarification. Author provided follow-up comments, but no changes were merged or implemented. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without resolution. Requested documentation improvements for the overlay field, including typo fixes, clearer explanations of exhaustive lists and path negation, and example corrections. No changes were applied, leaving it abandoned. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1418 docs: update overlay filter field description | craft-parts | merged | The overlay filter field documentation was updated and merged, closing issue #1401. Changes received two approvals, passed CI checks, and were integrated into the main branch. | |
| #370 docs: explanation section for overlays | craft-parts | merged | Merged documentation update adding an explanation section for overlays. Depends on and incorporates PR #365. Resolves CRAFT-1560. Approved by one reviewer with 273 additions and 9 deletions across eight files. |