docs(claude): add CLAUDE.md for AI assistant guidance
Summary
Add comprehensive documentation file to help Claude Code and other AI assistants understand the Komodo DeFi Framework codebase structure, build commands, and development workflows.
Changes
- Added
CLAUDE.mdwith build commands, test instructions, and architectural overview - Included platform-specific build instructions for native and WASM targets
- Documented core components: swap protocol, coin integration, P2P networking, and event system
- Provided guidance on key patterns and module hierarchy
Test plan
This is a documentation-only change. The file has been reviewed for accuracy based on existing documentation and codebase structure.
dunno if it's a standard but was just looking at this https://github.com/jackjackbits/heynow
here a single context.md is created and symlinked to from claude.md, codex.md, etc... i like it tho.
dunno if it's a standard but was just looking at this https://github.com/jackjackbits/heynow
here a single context.md is created and symlinked to from claude.md, codex.md, etc... i like it tho.
Thanks for the tip, this is still in progress as I am still trying to create the perfect claude.md. The problem with your suggested approach is that each model might require specific instructions and context tailored to how it works. If I want to leave how a model is used up to the user, I will opt for having a single context.md for context related to KDF only.
I encountered https://repoprompt.com/ earlier today which might be worth a look
This is still a work in progress PR that should follow the best practices for docs for AI. I will update other documentations like gitflow, Contributing Guide, and maybe not use claude.md for each crate (rename them to README.md or something more suitable). We should also have agents.md or any other files that can be used with other coding agents.