docs: post-migration audit for local-first Automerge architecture#560
Merged
docs: post-migration audit for local-first Automerge architecture#560
Conversation
…e architecture Update 12 files across AGENTS.md, README, contributing/, and docs/ to reflect the local-first Automerge migration (PRs #542-#554): - AGENTS.md: add Notebook Document Architecture section (WASM peers, mutation flow, sync flow), update key files table, add runtimed-wasm build note - README.md: add runtimed-wasm to project structure - contributing/architecture.md: conformance table now fully Conformant - contributing/build-dependencies.md: add runtimed-wasm to all three Mermaid diagrams and key points table - contributing/development.md: add wasm-pack manual build note - contributing/runtimed.md: cross-reference runtimed-wasm shared code - docs/runtimed.md: rewrite Phase 5 for actual local-first architecture, fix stale Known Limitations, update summary table - docs/python-bindings.md + python/runtimed/README.md: add session.save() - docs/logging.md: fix stale log prefixes - useDaemonKernel.ts: fix stale comment (notebook:updated → automerge:from-daemon)
Member
Author
|
One typescript file comment stopping this from getting the easy build path. |
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.
Post-migration documentation audit. Updates 12 files to reflect the local-first Automerge architecture from PRs #542–#554.
Changes
AGENTS.md / CLAUDE.md:
runtimed-wasm,useAutomergeNotebook.ts,materialize-cells.tscrates/notebook/src/lib.rsdescription updated (cell mutation commands removed)runtimed-wasm(same pattern as daemon separate-binary warning)README.md: Added
runtimed-wasmto project structure.contributing/architecture.md: Conformance table: "Mostly Conformant" → "Conformant" for Automerge and local-first editing.
contributing/build-dependencies.md: Added
runtimed-wasmto all three Mermaid diagrams and key points table.contributing/development.md: Added wasm-pack manual build note.
contributing/runtimed.md: Cross-reference to
runtimed-wasmsharednotebook_doc.rs.docs/runtimed.md: Rewrote Phase 5 section (was pervasively stale — referenced deleted files, deleted events, deleted commands, wrong architecture). Fixed Known Limitations sync race section. Updated summary table.
docs/python-bindings.md + python/runtimed/README.md: Added
session.save(path=None)documentation.docs/logging.md: Fixed stale log prefixes (
[notebook-sync]→[automerge-notebook]).useDaemonKernel.ts: Fixed stale comment (
notebook:updated→automerge:from-daemon).Closes the documentation gap from #540.