Skip to content

docs: split lif-core CLAUDE.md into topic docs (447 → 170 lines)#960

Open
bjagg wants to merge 1 commit into
LIF-Initiative:mainfrom
bjagg:docs/split-claude-md
Open

docs: split lif-core CLAUDE.md into topic docs (447 → 170 lines)#960
bjagg wants to merge 1 commit into
LIF-Initiative:mainfrom
bjagg:docs/split-claude-md

Conversation

@bjagg
Copy link
Copy Markdown
Contributor

@bjagg bjagg commented May 29, 2026

Summary

Splits the lif-core CLAUDE.md from 447 lines down to 170 (under the 200-line target) by moving five detail-heavy sections into dedicated docs under docs/. Each section is replaced inline with a concise summary that preserves the high-value quick facts an agent needs, plus a pointer to the full doc — keeping CLAUDE.md as the dense agent-oriented map it already describes itself as.

What moved

Section New home
Testing docs/operations/guides/testing.md
LIF Schema & Data Model docs/design/cross-cutting/schema-loading.md
Semantic Search MCP Server docs/design/components/semantic-search.md
GraphQL API Key Authentication docs/operations/guides/graphql-api-keys.md
Deployment & Operations docs/operations/guides/deployment.md

Content was moved faithfully (no information lost) and cross-linked between the new docs where they reference each other.

Also

  • Registered all five new docs in docs/INDEX.md and removed schema-loading.md from the "planned topics" note (per the docs-index skill convention).
  • Sections kept inline: Project Overview, Companion docs, Commands, Architecture, Code Conventions, Commit Convention, Pre-commit Hooks, Key Technologies.

🤖 Generated with Claude Code

Move five detail-heavy sections out of CLAUDE.md and replace each with a
concise summary plus a pointer, keeping it as the dense agent-oriented map.

- Testing            -> docs/operations/guides/testing.md
- Schema & Data Model -> docs/design/cross-cutting/schema-loading.md
- Semantic Search    -> docs/design/components/semantic-search.md
- GraphQL API Keys   -> docs/operations/guides/graphql-api-keys.md
- Deployment & Ops   -> docs/operations/guides/deployment.md

Register the new docs in docs/INDEX.md.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

1 participant