Document the local multi-repo build system - #13
Closed
ritorhymes wants to merge 4 commits into
Closed
Conversation
Add the local workspace model for the multi-repo build system. This adds workspace config and profile support, workspace init, refresh, and doctor commands, generated helper tasks, and the local site build path against sibling repos and theme inputs. The site commands support normal local usage, parity checks, standard clone and git worktree checkouts, and explicit dirty builds from the active content repo.
Add explicit editorial commands and keep them separate from the site command surface. This adds targeted editorial selection and lets proposal validation run independently from the normal site build and check commands.
Add local serving and preview paths for the multi-repo workflow. serve runs the live Zola dev loop and syncs tracked working-tree edits into the build-time repo during the session. preview serves already-built output without rebuilding.
Document the local multi-repo workflow and command surface. Describe local workspace setup, dirty workflow, site commands, editorial commands, parity usage, and the separate serve and preview paths using stable public-facing terminology.
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.
Important
This is the fourth and final PR in the stacked
preprocessorseries for preprocessor#8, splitting the original implementation in preprocessor#9 into smaller reviewable slices. This PR builds on the earlier workspace (#10), editorial (#11), and local runtime (#12) slices and adds the public-facing documentation for the full command surface and workflow.Description
This PR documents the local multi-repo build system introduced in the earlier stacked PRs.
It describes the local workspace model, the site and editorial command surfaces, the dirty workflow path, parity-oriented usage, and the distinction between local serving and built-output preview.
Changes
check,build,serve, andpreviewcommandsValidation
This documentation slice builds cleanly on top of the earlier stacked slices:
cargo buildThe documented command surface and workflows describe the same final implementation preserved by this stacked series from preprocessor#9.