docs: true up the doc set for local-writes (compat/roadmap/skill-lint)#134
Closed
lance0 wants to merge 1 commit into
Closed
docs: true up the doc set for local-writes (compat/roadmap/skill-lint)#134lance0 wants to merge 1 commit into
lance0 wants to merge 1 commit into
Conversation
…lint drift The ADR-0002 local stdio write mode re-introduced drift across the doc set; this sweep makes the MCP write story consistent and corrects stale/broken docs. - MCP writes: every surface (README, MCP.md, SECURITY, KNOWN_ISSUES, AGENTS, skills, comparison) now distinguishes local stdio `--local-writes` (profile token) from shared HTTP/OIDC `--allow-writes` + `nbox:write` + `[serve.vault]`. - ROADMAP: drop stale read-only framing (read-first product/UX), fix the Writes section heading + anchor, note the live MCP E2E CI coverage. - COMPATIBILITY: split 4.5 vs 4.6 so ETag/If-Match is attributed only to 4.6, and expand the allocate-write note to all three reserve commands. - ARCHITECTURE: document mutation.rs, write_audit.rs, and the write flow. - BENCHMARKS: mark the numbers historical (0.13.0-era), not current 0.14. - Skill lint now covers the root SKILL.md (lint_skills.sh + skills-lint trigger). - release.yml: drop the stale keyring build comment (keyring removed in 0.8.0). Docs + workflows only — no Rust change.
Owner
Author
|
Merged as |
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.
Follow-up to the ADR-0002 local-writes work: that feature changed the write story everywhere, so this sweep re-aligns the docs and fixes confirmed drift. Reviewed/verified before landing.
Changes
--local-writes(profile token) vs shared HTTP/OIDC--allow-writes+nbox:write+[serve.vault].SKILL.md(lint_skills.sh+ the skills-lint workflow trigger).Verified
lint_skills.sh passes (root SKILL.md covered); COMPATIBILITY split is factually correct; MCP-write framing uniform with no local/shared conflation; no residual flat "read-only server" claims; ROADMAP anchors resolve; docs + workflows only, no Rust.