docs: add CLAUDE.md and AGENTS.md repository guide#407
Open
zc277584121 wants to merge 1 commit into
Open
Conversation
Document the monorepo layout, the pnpm build/test workflow, the Context orchestrator and its pluggable embedding/vectordb/splitter interfaces, incremental Merkle-DAG sync, and commit conventions. AGENTS.md is a symlink to CLAUDE.md; the CLAUDE.md ignore entry is dropped so the guide is tracked.
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.
What
Adds a
CLAUDE.mdrepository guide (withAGENTS.mdas a symlink to it), and removes theCLAUDE.mdline from.gitignoreso the shared guide can be tracked.CLAUDE.mddocuments:core/mcp/vscode-extension/chrome-extension) and how the frontends consumecore/distviaworkspace:*.core, the Node built-in runner viatsxformcp).Contextorchestrator and its pluggable embedding / vector-db / splitter interfaces, the two control-flow error types, incremental Merkle-DAG sync, layered ignore-pattern resolution, and the MCP server's "stdout is reserved for the protocol" constraint.Why
Gives contributors a single, accurate description of the architecture and workflow instead of reverse-engineering it from the source, and lets the coding tools many of us use pick up the same context.
AGENTS.mdis a symlink toCLAUDE.md, so tools following either convention read the same content.Note on
.gitignore.gitignorepreviously listedCLAUDE.md(treating it as a personal/local file). This PR drops that one line so the shared guide is committed;.claude/*stays ignored. Happy to revert that part if you'd rather keepCLAUDE.mdlocal and ship onlyAGENTS.md.