chore: consolidate to .claude/ + CLAUDE.md, add internal docs#408
Merged
Conversation
- Rename AGENTS.md -> CLAUDE.md and drop the CLAUDE.md->AGENTS.md redirect; update in-repo references that pointed at the old filename (tests/README.md, ladybug_queries.py, mcp_v2.py, and the CI paths-filter). - Migrate the agent/skill tree from .agents/ -> .claude/ (now tracked) and drop the .claude/.cursor ignore lines from .gitignore. - Add the first internal docs: docs/DESIGN.md (WHAT/WHY) and docs/ARCHITECTURE.md (HOW), linked from CLAUDE.md's Docs section. Co-Authored-By: Claude <noreply@anthropic.com>
Ported from the agctl project — it referenced agctl.yaml, discover, the mock server, and http/kafka/db modes, none of which exist here. Rewrote end-to-end for this repo's docs at three altitudes: internal (DESIGN.md WHAT/WHY, ARCHITECTURE.md HOW), operator docs (CONFIGURATION, JAVA-CODEBASE-RAG-CLI, AGENT-GUIDE, CODEBASE_REQUIREMENTS, MANUAL-VERIFICATION-CHECKLIST), and consumer artifacts (skills/ + agents/, deployed verbatim via install/update). Kept the altitude/scope/staleness decision framework and default-to-no-op behavior. Added what's specific to this project: the AGENT-GUIDE -> skill/agent source-of-truth chain, the staleness axes for facts repeated across files (ONTOLOGY_VERSION=18, the 5 MCP tools, node kinds, EDGE_SCHEMA, CLI exit codes, config precedence), and the rule that EDGE-NAVIGATION.md is generated from EDGE_SCHEMA (regenerate, never hand-edit; --check enforced in CI). PRODUCT-VISION.md and paper.pdf stay frozen/aspirational. Co-Authored-By: Claude <noreply@anthropic.com>
Moved the 7 in-flight items that correspond to already-shipped work into
their completed/ folders:
plans/active/PLAN-{ABSENCE-DIAGNOSIS,GENERATED-SOURCE-INDEXING,JRAG-CLI,SEARCH}.md
-> plans/completed/
propose/{ABSENCE-DIAGNOSIS,GENERATED-SOURCE-INDEXING,JRAG-CLI}-PROPOSE.md
-> propose/completed/
propose/stale/ left untouched — those proposals are deferred/superseded,
not completed.
Co-Authored-By: Claude <noreply@anthropic.com>
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.
Summary
Housekeeping chore: consolidate the repo onto Claude conventions and add the first internal docs.
Agent-tooling migration
AGENTS.md→CLAUDE.md— drop theCLAUDE.md→AGENTS.mdredirect; the full contributor instructions now live atCLAUDE.md(which Claude Code reads directly)..agents/→.claude/— the tracked agent/skill tree moves to.claude/;.claude/.cursorremoved from.gitignoreso the new tree is version-controlled.Reference fixes (point at the renamed file)
Updated in-repo pointers:
tests/README.md,ladybug_queries.py,mcp_v2.py, and the.github/workflows/test.ymlpaths-filter (AGENTS.md/.agents/**→CLAUDE.md/.claude/**). Generic consumer-facing mentions ("copy-paste into yourAGENTS.md/CLAUDE.md") and historicalpropose//plans/refs are intentionally left unchanged.Internal docs (first ones)
docs/DESIGN.md— WHAT/WHY: core principles, what's indexed, surfaces, non-goals.docs/ARCHITECTURE.md— HOW: pipeline, module map, write/read paths, stores, extension points (3 ASCII diagrams).CLAUDE.md'sDocssection. Grounded in the actual source; accuracy- and clarity-reviewed.Notes
.pyfiles.ladybug_queries.py/tests/README.mdnow points atCLAUDE.md, but that section isn't present in the file — the pitfalls text itself lives in theladybug_queries.pydocstring. Restoring the section is out of scope here.🤖 Generated with Claude Code