docs: add recipes section and artifacts configuration reference#81
Merged
Conversation
Surface the existing knobs (artifacts.enabled, tag filter, platforms) as named patterns so users can find them without reading the full configuration reference end to end. Production-fidelity is named as a deliberate choice; minimum-bytes preserves multi-arch by default; single-architecture lives behind a warning header documenting the bit-for-bit divergence. Adds: - Recipes top-level docs section with seven pages (production, minimum-bytes, pin-literals, helm + images, variant, semver, single-architecture) - Artifacts configuration section with enabled/include/exclude/require_artifacts reference and rationale for default-on - Dual quickstart in README distinguishing full-fidelity from minimum-bytes - Bit-for-bit framing in the README tagline so the project's content-integrity promise is visible above the fold
bryantbiggs
force-pushed
the
docs/recipes-and-artifacts
branch
from
May 4, 2026 15:39
44d8430 to
41cfd75
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PR 4 of the tag-filter + artifacts rollout. Pure docs — no code touched. Surfaces existing knobs as named patterns so users can find them without reading the configuration reference end to end.
enabled/include/exclude/require_artifacts) with rationale for default-on.README.mddistinguishing full-fidelity from minimum-bytes, and surfaces the bit-for-bit framing in the tagline.cosign verify, and arm64-consumer failure — the only ocync recipe that opts out of bit-for-bit.Multi-arch is preserved in every standard recipe. The
platforms:filter is documented as the single existing exception to bit-for-bit and isolated to the advanced recipe.Linked: #80 (registry URL rewriting investigation, referenced from helm-chart-and-images).
Test plan
npm run --prefix docs build— 28 pages built, no errors/recipes/docs/CLAUDE.mdconventionnpm run --prefix docs previewand click through the dual quickstart and one recipegh-pagesdeploy renders correctly under the/ocync/base path