Skip to content

docs(sdk): package documentation for all three kits#1

Merged
bob-codedaptive merged 2 commits into
mainfrom
feat/sdk-docs
Jul 5, 2026
Merged

docs(sdk): package documentation for all three kits#1
bob-codedaptive merged 2 commits into
mainfrom
feat/sdk-docs

Conversation

@bob-codedaptive

Copy link
Copy Markdown
Member

Adds the four SDK doc deliverables per package (OVERVIEW.md, DETAILS.md, AGENT_MAP.md, topology.svg) for CorpusKit, LocusKit, and VectorKit. The EE-shipped CorpusKit docs/INTERFACE_DOCTRINE.md is untouched.

  • Voice: Turabian/Chicago at 8th-grade reading level (FK 8.0 ceiling, verified by docs-style-lint in mootx01-ee scripts). No em-dashes.
  • Front matter pins authored_commit and per-source git blob hashes; docs-scrub detects drift.
  • AGENT_MAP.md is the token-optimized agent index and is voice-exempt.
  • Docs are venue-authored by design. The publisher preserve patch (mootx01-ee feat/publish-preserve-docs) carries them through future publish refreshes.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Pzkqg3bpbbhfuWRsYomJ3o

Fable and others added 2 commits July 4, 2026 16:06
…ogy per package

Phase 3-4 of the Moot-SDK documentation initiative. Voice: Turabian at
8th grade per the LatticeLib pilot exemplar. Front-matter pins per-repo
authored_commit and per-source git blob hashes for docs-scrub.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Pzkqg3bpbbhfuWRsYomJ3o
…m-dashes

Full rewrite of OVERVIEW.md and DETAILS.md per package: Turabian/Chicago,
reading level 8.0 or less, no sentence over 2 commas outside simple
lists, no 'not X, but Y' or 'it is not X, it is Y' forms. AGENT_MAP and
topology.svg scrubbed of em-dashes only. Front matter unchanged. Gated
by scripts/docs-style-lint.py (mootx01-ee): 65/65 pass; docs-scrub clean.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Pzkqg3bpbbhfuWRsYomJ3o
@bob-codedaptive bob-codedaptive merged commit 4edc8db into main Jul 5, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant