← Back to issue list

feat(docs): add definition for overlay_step in the docs

View original Github issue

Metadata

Project
rockcraft
Number
#436
Type
pull request
State
merged
Author
linostar
Labels
Created
Updated
Closed

Current evaluation

Merged documentation update adding the missing overlay_step definition to Rockcraft docs. Maintainers chose to merge the standalone paragraph as-is, deferring upstream craft-parts doc inheritance improvements for later.

Suggested action:

No scores available.

Issue body

- [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? ----- I added the missing definition for the overlay-step in explanation docs. Note that the overlay_parameters common doc mentions `overlay-filters` field, but apparently that's a typo and it should be `overlay-files`. I fixed that in rockcraft docs, but it needs to be fixed in craft-parts docs too.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged documentation update adding the missing overlay_step definition to Rockcraft docs. Maintainers chose to merge the standalone paragraph as-is, deferring upstream craft-parts doc inheritance improvements for later.
qwen3.6-35b-a3b-mtp-q6 Merged the addition of the missing overlay_step definition to the documentation. Maintainers opted to merge the standalone paragraph as-is for now, deferring upstream inheritance from craft-parts pending repo updates.
qwen3.6-35b-a3b-mtp-q6 Merged addition of the missing overlay_step definition to Rockcraft docs. Maintainers opted to merge as-is rather than waiting for upstream craft-parts doc structure updates. Also fixed an overlay-filters typo.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#512 Document `overlay-packages` rockcraft open Docs gap: overlay-packages missing from Rockcraft part_properties reference. The referenced page now redirects to rockcraft.yaml, which documents overlay parameters via an included craft-parts fragment, so the gap is likely resolved. No maintainer activity in 263 days.
74%
#680 doc: missing overlay info in rockcraft.yaml reference rockcraft closed Closed as outdated. The missing overlay step reference was already documented in the official Rockcraft reference. Maintainer @asanvaq confirmed the documentation exists and closed the issue without further action.
74%
#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.
73%
#486 overlay-packages is not documented in rockcraft.yaml reference rockcraft open overlay-packages (and other overlay part properties) are missing from the rockcraft.yaml reference docs; maintainer noted the fix belongs in craft-parts' part_properties.rst. Still open with no follow-up.
71%