docs: document the per-component monorepo model - #531
Merged
Merged
Conversation
Add a how-to guide for splitting a repository into components, distinct from the multi-repo guide, and document the components manifest block in the reference (required path and tag_prefix, the inheritable per-component overrides, the repository-wide fields rejected per component, the concurrency group rejection, and the tag-namespace collision error). Move per-component versioning into a live reference section, and add a short explanation that multi-component is the native schema_version 1 shape: a manifest with no components block is one implicit component that generates byte-identical output, so single-component users are unaffected and nothing needs migrating. Add a multi-component row to the README capability table. Refs #298, #503. Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
This was referenced Jul 8, 2026
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
1 participant
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.
What
Public documentation for the multi-component (monorepo) model, now that the behavior has shipped.
guides/components.md, new): splitting a repository into components, distinct from the multi-repo guide.reference/manifest.md): thecomponents:block, requiredpath/tag_prefix, the inheritable per-component overrides, the repository-wide fields rejected per component, the concurrency-group rejection, and the tag-namespace collision error.reference/versioning.md): per-component versioning moved into a live section (path-scoped commits, strict per-component tag namespace,state.components.<name>.<env>).start/how-it-works.md): multi-component is the nativeschema_version: 1shape; a manifest with nocomponents:block is one implicit component with byte-identical output, so single-component users are unaffected and nothing needs migrating.Verification
Docs site builds:
npm run buildsucceeds (24 pages). Guardrail scan of the changed docs is clean. The multi-component manifest example is schema-valid.Refs #298, #503.