Skip to content

Rewrite documentation to match codebase#46

Closed
jsk11235 wants to merge 1 commit intomainfrom
docs-rewrite
Closed

Rewrite documentation to match codebase#46
jsk11235 wants to merge 1 commit intomainfrom
docs-rewrite

Conversation

@jsk11235
Copy link
Copy Markdown
Collaborator

Summary

  • Rewrote all documentation based solely on reading the code (not existing docs)
  • README.md now accurately covers installation, CLI, configuration (providers, frameworks, groups), env var expansion, exit codes, and library usage
  • Added ARCHITECTURE.md with detailed technical design (module structure, core abstractions, execution flow, concurrency model)
  • Simplified TESTING.md to focus on running tests and required checks
  • Simplified CLAUDE.md for AI agent guidance with key files and patterns
  • Removed outdated files: AGENTS.md, STYLE_GUIDE.md, .claude/agents/*.md
  • Updated code doc comments in lib.rs, config.rs, provider.rs to include ModalProvider

Test plan

  • cargo fmt --check passes
  • cargo clippy passes
  • Documentation accurately reflects actual code

🤖 Generated with Claude Code

- Replace README.md with accurate config and usage docs
- Add ARCHITECTURE.md with technical design details
- Simplify TESTING.md to focus on running tests
- Simplify CLAUDE.md for AI agent guidance
- Remove outdated AGENTS.md, STYLE_GUIDE.md, and .claude/agents/
- Update code doc comments to include ModalProvider

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vet found 0 issues.

@jsk11235
Copy link
Copy Markdown
Collaborator Author

Closed in favor of newer docs update

@jsk11235 jsk11235 closed this Feb 26, 2026
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