Skip to content

Conversation

@RonaldJEN
Copy link

Add comprehensive documentation file (CLAUDE.md) that provides AI assistants with detailed guidance on working with the Mini Agent codebase, including:

  • Complete project overview and key features
  • Detailed repository structure and architecture explanation
  • Core components documentation (Agent, LLM abstraction, Tools, Config)
  • Development workflows and setup instructions
  • Code style conventions and commit message format
  • Guidelines for adding new tools and MCP integrations
  • Testing best practices and debugging tips
  • Common pitfalls and troubleshooting guide
  • Quick reference for common tasks

This guide helps AI assistants understand the codebase structure, follow project conventions, and make appropriate contributions.

Add comprehensive documentation file (CLAUDE.md) that provides AI assistants
with detailed guidance on working with the Mini Agent codebase, including:

- Complete project overview and key features
- Detailed repository structure and architecture explanation
- Core components documentation (Agent, LLM abstraction, Tools, Config)
- Development workflows and setup instructions
- Code style conventions and commit message format
- Guidelines for adding new tools and MCP integrations
- Testing best practices and debugging tips
- Common pitfalls and troubleshooting guide
- Quick reference for common tasks

This guide helps AI assistants understand the codebase structure, follow
project conventions, and make appropriate contributions.
@RonaldJEN RonaldJEN closed this Nov 17, 2025
@RonaldJEN RonaldJEN deleted the claude/claude-md-mi2ktzntmmqwvara-01QbTDpo1uew3iGn9Tp4ADYE branch November 17, 2025 05:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants