| name | documentation |
| description | Defines public README, maintainer-document, and agent-instruction structure, source-of-truth boundaries, concise prose, formatting, and voice for @samchon/graph. Use before writing, modifying, renaming, or moving repository Markdown documentation, CLI or MCP examples, benchmark methodology, language-support instructions, AGENTS.md, or SKILL.md files. |
Documentation
Public README
The root README.md is the canonical public document for package users. Start with what @samchon/graph is, the problem it solves, installation, the smallest MCP setup, language-server prerequisites, benchmark evidence, and the common operational path.
Keep public prose direct and practical. Explain internal ranking, protocol, or indexer details only when a user needs them to interpret the contract or benchmark honestly.
packages/graph/README.md is ignored and copied from the root during package build. Never edit it directly. If the package copy is stale, rebuild after updating the root source.
Contract Synchronization
The README embeds and explains the public MCP application contract, and test_readme_embeds_the_exact_application_contract.ts guards that relationship. The TypeScript block sourced from packages/graph/src/structures/ISamchonGraphApplication.ts must remain byte-for-byte synchronized with the contract region that the test selects. When changing ISamchonGraphApplication, request/result unions, tool descriptions, supported languages, CLI forms, or trust claims:
- Update the owning TypeScript types and JSDoc first.
- Update the root README's exact contract excerpt and surrounding explanation.
- Run the focused README contract test and the relevant public-surface tests.
Do not weaken the test, hand-edit generated package output, or leave examples describing a schema the server no longer accepts.
Maintainer Documents
