Portable doc-site guide (#263, reframed) - #313
Merged
Merged
Conversation
The old docs.rotkeeper.com domain is abandoned, so the issue is reframed from "auto-generate a dead domain" to "the docs are portable generated output." New home/content/docs/publishing.md documents: - what the pipeline produces (render -> output/, dip -> dip-matrix + book reports, book binders -> bones/book-reports, showcase -> gallery) — the same bytes any workstation generates on a full docs run - that output/ is self-contained static HTML (relative asset links, no JS runtime, no server, no CDN) and publishes as-is to any static host - GitHub Pages as one option among many — it serves identical bytes to a local run, a hosting choice rather than a pipeline - what not to do: commit output/, wire CI to a specific domain, or hand-edit generated artifacts Linked from the docs index under a new "Hosting the Generated Docs" section. Validated: render + status green, no scripts touched.
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.
Closes #263 (reframed).
The rotkeeper.com domain is abandoned, so "auto-generate docs.rotkeeper.com" was the wrong target. The reframed scope: the docs are portable generated output — the same bytes any workstation produces on a full render + DIP + book run — publishable to any static host.
New
home/content/docs/publishing.md:render→output/,dip→dip-matrix.md+ book reports,bookbinders →bones/book-reports/,showcase→ gallery)output/is self-contained static HTML (relative asset links, no JS runtime, no server, no CDN) and publishes as-is to any static hostoutput/, wire CI to a specific domain, hand-edit generated artifactsLinked from the docs index under "Hosting the Generated Docs". Validated: render + status green, no scripts touched.