Repository navigation
docs: rename the spec to Protocol.md, drop the raw research files - #26
Merged
Merged
Conversation
…2-digest closure)
Three reviewed changes:
1. The spec file 'Protocol v0.1.md' is renamed to 'Protocol.md'. The
old name carried the first release's version while the file itself
is the living, version-tracking spec (currently v4) — the name lied
on every citation. The MCP-style timestamped-snapshot layout was
considered and rejected: ffsync's spec is one living document
wire-referenced from ~15 places; timestamping would fork every
reference at each change, and git history already preserves past
states. All 15 references updated (5 module docs, README x2,
AGENTS.md, CONTRIBUTING.md, the decisions ledger x3, the workflow
doc); the spec header notes the old name for provenance.
2. The two raw deep-research files ('Designing a High-Performance…'
and 'P2P Connection Challenge Resolution.md') are removed. The
digest is the working copy (F1-F4 all closed with updates recorded
in it); the raw files were provenance — tracked since a16b4e9, so
git history preserves them byte-for-byte. The digest's provenance
header is rewritten to say so. AGENTS.md no longer instructs agents
to read 470 lines of raw Gemini research before making changes.
3. The digest's prolly-tree row is closed honestly: the full
Merkle-divergence index was rejected by D17 (the structured version
of the rejected 'mega-manifest': collapses per-file identity,
recreates the large-tree memory problem, adds a persistent per-tree
index) while per-file conversations adopted the spirit (the
per-file root-hash fast path localizes divergence). The row had
still read as a pending follow-up — a documentation bug. Revisit as
a spec §14 extension point only if high-RTT huge-tree sessions
dominate.
Verified: no dangling references (grep clean); all concept/ links
resolve (link + backtick checked); full gates green.
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
The three reviewed documentation-structure changes:
concept/Protocol v0.1.md→concept/Protocol.md. The old filename carried the first release's version; the file is the living, version-tracking spec (currently v4) — the name lied on every citation. The MCP-style timestamped-snapshot layout was considered and rejected (a living spec wire-referenced from ~15 places would fork every reference on each change; git history already preserves past states). All 15 references updated; the spec header notes the old name.a16b4e9) preserves them byte-for-byte. The digest's provenance header is rewritten accordingly; AGENTS.md no longer sends agents to read the raw files.Verification
grepclean: no dangling old-name or removed-file references outside the two intentional provenance notes.-D warnings, all suites (43 unit + loopback 23 + tree 28 + tls/quic/soak/integration).