Repository navigation
docs: a local preview that stays browsable while the docs are rebuilt - #459
Merged
Merged
Conversation
`make.jl` clears `docs/build/` first, so a server on it shows nothing during a build. `docs/preview.sh build` builds as usual, then swaps the finished site into `docs/build-preview/`; `docs/preview.sh serve` serves it (port 5175). A failed build keeps the previous preview. Taken from OptimalControl's `docs/preview.sh`. Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
16 of 53 tasks
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.
Refs #449 (T7, known lead). Applied conventions:
ct-conventions v0.14.0,ct-agents v0.5.0.docs/make.jlclearsdocs/build/before it builds, so a server pointed at it returns 404 for the whole build. This addsdocs/preview.sh, taken from OptimalControl:buildrunsjulia --project=docs docs/make.jl, copiesdocs/build/1intodocs/build-preview/and swaps it in at the end. A failed build keeps the previous preview. The port is 5175 (OptimalControl uses 5174), so both previews can run at once.Changes
docs/preview.sh(new, a local tool: CI does not use it)..gitignore:docs/build-preview*/.docs/make.jlheader anddocs/src/developers.md("The documentation"): how to use it.Test plan
docs/preview.sh buildon a fresh worktree whose docs environment was not instantiated fails with "build failed, preview kept" and leaves no preview; afterPkg.instantiate, it builds and prints "preview updated", anddocs/build-preview/is git-ignored.🤖 Generated with Claude Code