Repository navigation
docs: site archives guide and starter demo archive (#47, step 5) - #133
Merged
Merged
Conversation
RFC-0039 rollout step 5, the demo half. packages/cli/test/fixtures/ site-archives/starter-blog.cloudhal is the site `cloudhal init` seeds plus one published snapshot, written by `pnpm demo:archive` with a fixed clock and counter ids through init's own seeding code (seedStarter, split out of seed-site.ts with no behaviour change). `node scripts/demo-archive.ts --check` (in pnpm check and CI) compares the committed archive's manifest, never its gzip bytes (invariant 7 as amended), and fails when the current code would export something else. .gitattributes marks *.cloudhal binary; archives exported inside a starter are ignored. The fixture does not ship. Refs #47 Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: Madraka <[email protected]>
RFC-0039 rollout step 5, the docs half. docs/guides/site-archives.md covers what an archive holds and leaves out (now also scheduled releases, pending approvals and open edit suggestions, which export prints too), backups, moving a site, keeping content in git (fresh clones and later --replace imports), demos, every export and import flag with real output, --replace and its --revert undo, the site-id switch, takedowns, determinism, untrusted files and troubleshooting by message. It is listed on the docs index and quickstart; the CLI README, the starter README, installation, the threat model and AGENTS.md point to it. RFC-0039 and ADR-0041 record what step 5 found: graph rows are held in memory and an import is one node batch of at most 1000 statements (as push and pull), with streaming and larger imports listed under Later; the RFC is marked implemented. Closes #47 Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: Madraka <[email protected]>
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.
What
This is the last step (5) of RFC-0039's rollout. It closes #47. Steps 1–4 were #129, #130, #131 and #132.
docs/guides/site-archives.md. It covers:exportnow prints these too. The guide also says plainly that the history names who made each change.import, and a later archive is applied withimport --replace;export/importflag, with real output captured from the bin.--replaceand its--revertundo, the site-id switch and its undo, and takedowns.age/gpgfor confidentiality), and troubleshooting by message.exportandimport.content/site.cloudhal),installation.md, the threat model (an accepted risk: archives are unsigned) and AGENTS.md (the Layout line, pluspnpm demo:archive).packages/cli/test/fixtures/site-archives/starter-blog.cloudhal(2.9 KiB) holds the sitecloudhal initseeds plus one published snapshot.pnpm demo:archivewrites it with a fixed clock and counter ids, using init's own seeding code.seedStarterwas split out ofseed-site.tswith no behaviour change.node scripts/demo-archive.ts --checkruns inpnpm checkand CI. It compares the committed archive's manifest, not its gzip bytes (invariant 7 as amended), and fails when the current code would export something else..gitattributesmarks*.cloudhalas binary, and archives exported insidestarters/are ignored.init --from(Later).For the owner
ai_settings/ai_usage) and the schedule kill switch and cap (schedule_settings) are not exported either. They could be added to the "never in an archive" list.curlURL points atmain, so it works once this merges.npx cloudhal importneeds the next CLI release (release PR chore(release): version packages #125).Verification (local)
node scripts/demo-archive.ts --checkreports up to date. Two negative tests fail it as expected: a--no-mediaexport swapped in, and a changed node. Regenerating the archive is byte-identical, andtar -tzvflists 5 entries, all0 0, 1970.cloudhal.jsonnamessite_starter0001behaves as documented: the dry run lists 9 nodes and 1 snapshot, the import writes them, and a second run prints "nothing to import".@cloudhal/docs: tests (33, including the link checker and the CLI reference), typecheck, and the build (118 pages, guide and llms.txt entry present).packages/cli: 13 files and 208 tests (archive-*,export-cli,import-*,cli-commands,demo-archive) in one process.pnpm lint,pnpm size:checkand the CLI typecheck pass.git check-attrreports the fixture as binary.Checklist
pnpm checkandcargo test --workspacepass locally. I ran the pieces that cover this change; there is no Rust or contract change, and CI runs the rest.exportnow also prints scheduled releases, pending approvals and open edit suggestions. That is folded into the still-unreleased.changeset/site-archive-export.md.git commit -s, DCO)Closes #47
🤖 Generated with Claude Code