Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,13 @@ MCP enables AI coding assistants (GitHub Copilot, Claude, Cursor) to interact di

See [docs/MCP_SETUP.md](docs/MCP_SETUP.md) for configuration details and usage guide.

## Community & Support

- **Discussions**: [GitHub Discussions](https://github.com/BitSleuthAI/Analyzer/discussions) — ask questions, share ideas, and connect with other users
- **Bug Reports**: [Open an issue](https://github.com/BitSleuthAI/Analyzer/issues/new?template=bug_report.md)
- **Feature Requests**: [Request a feature](https://github.com/BitSleuthAI/Analyzer/issues/new?template=feature_request.md)
- **Security**: Report vulnerabilities privately to `security@bitsleuth.ai` (see [SECURITY.md](SECURITY.md))

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on contributing to BitSleuth, including documentation standards and file organization.
Expand Down
94 changes: 60 additions & 34 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,53 +2,79 @@

This directory contains all documentation files for the BitSleuth project.

## Documentation Files
## Product & Planning

### Product & Planning
- **[PRD.md](PRD.md)** - Product Requirements Document with detailed feature specifications
- **[todo.md](todo.md)** - Development roadmap and task tracking
- **[PRD.md](PRD.md)** — Product Requirements Document
- **[todo.md](todo.md)** — Development roadmap and task tracking
- **[TAX_FAQ.md](TAX_FAQ.md)** — Tax feature frequently asked questions
- **[TAX_REPORTING_GUIDE.md](TAX_REPORTING_GUIDE.md)** — Tax reporting user guide
- **[ACCOUNTING_METHODS.md](ACCOUNTING_METHODS.md)** — Supported accounting methods (FIFO, LIFO, etc.)

### Marketing & Strategy
- **[SEO_STRATEGY.md](SEO_STRATEGY.md)** - SEO guidelines and optimization strategies
- **[ai-training-content.md](ai-training-content.md)** - AI training content and SEO keywords
## Setup & Configuration

### Development & Tools
- **[TAILWIND_SETUP.md](TAILWIND_SETUP.md)** - Tailwind CSS Language Server setup and configuration
- **[MCP_SETUP.md](MCP_SETUP.md)** - Model Context Protocol setup and configuration guide
- **[GOOGLE_SHEETS_TROUBLESHOOTING.md](GOOGLE_SHEETS_TROUBLESHOOTING.md)** - Google Sheets integration troubleshooting
- **[TESTING_FEEDBACK_FIX.md](TESTING_FEEDBACK_FIX.md)** - Feedback system testing guide
- **[TAILWIND_SETUP.md](TAILWIND_SETUP.md)** — Tailwind CSS Language Server setup
- **[MCP_SETUP.md](MCP_SETUP.md)** — Model Context Protocol setup for AI-assisted development
- **[GOOGLE_SHEETS_TROUBLESHOOTING.md](GOOGLE_SHEETS_TROUBLESHOOTING.md)** — Google Sheets integration troubleshooting
- **[dependabot-configuration.md](dependabot-configuration.md)** — Dependabot setup and configuration
- **[BITCOIN_DEPENDENCY_UPDATES.md](BITCOIN_DEPENDENCY_UPDATES.md)** — Bitcoin library dependency notes
- **[RULES_FILE_DOCUMENTATION.md](RULES_FILE_DOCUMENTATION.md)** — `.rules` file security policy documentation

## Documentation Guidelines
## Performance

**Important:** All markdown documentation files must be stored in this `docs/` folder.
- **[PERFORMANCE_OPTIMIZATION.md](PERFORMANCE_OPTIMIZATION.md)** — Performance optimization strategies
- **[PERFORMANCE_OPTIMIZATION_SUMMARY.md](PERFORMANCE_OPTIMIZATION_SUMMARY.md)** — Summary of optimization results
- **[PERFORMANCE_FIX_SUMMARY.md](PERFORMANCE_FIX_SUMMARY.md)** — Performance fix changelog
- **[PERFORMANCE_IMPROVEMENT_SUMMARY.md](PERFORMANCE_IMPROVEMENT_SUMMARY.md)** — Measured improvement details
- **[ULTRA_FAST_LOGIN_OPTIMIZATION.md](ULTRA_FAST_LOGIN_OPTIMIZATION.md)** — Login flow optimization
- **[wallet-snapshot-caching.md](wallet-snapshot-caching.md)** — Wallet snapshot caching technical design
- **[performance-diagram.txt](performance-diagram.txt)** — Performance flow diagram

For more information about contributing documentation, see [CONTRIBUTING.md](../CONTRIBUTING.md) in the repository root.
## Architecture & Design

### Exceptions
- **[FAST_DASHBOARD_DESIGN.md](FAST_DASHBOARD_DESIGN.md)** — Dashboard performance design
- **[PROGRESSIVE_LOADING_DESIGN.md](PROGRESSIVE_LOADING_DESIGN.md)** — Progressive loading architecture
- **[PROGRESSIVE_LOADING_SUMMARY.md](PROGRESSIVE_LOADING_SUMMARY.md)** — Progressive loading implementation summary
- **[PROGRESSIVE_LOADING_VALIDATION.md](PROGRESSIVE_LOADING_VALIDATION.md)** — Progressive loading validation results
- **[LOGIN_FLOW_FIX.md](LOGIN_FLOW_FIX.md)** — Login flow fix details
- **[LOGIN_FLOW_QUICK_REF.md](LOGIN_FLOW_QUICK_REF.md)** — Login flow quick reference

The following markdown files are allowed at the repository root level:
- `README.md` - Main project documentation
- `LICENSE` or `LICENSE.md` - License information
- `CONTRIBUTING.md` - Contribution guidelines
- `AGENTS.md` - Agent overview and project structure
- Files in `.github/` directory - GitHub-specific configurations
## Fix & Implementation Summaries

## Adding New Documentation
- **[IMPLEMENTATION_SUMMARY.md](IMPLEMENTATION_SUMMARY.md)** — Feature implementation summary
- **[COMPLETE_SOLUTION_SUMMARY.md](COMPLETE_SOLUTION_SUMMARY.md)** — Complete solution overview
- **[SOLUTION_SUMMARY.md](SOLUTION_SUMMARY.md)** — Solution summary
- **[FINAL_VALIDATION_REPORT.md](FINAL_VALIDATION_REPORT.md)** — Final validation report
- **[FIX_LOADING_TIMEOUT_SUMMARY.md](FIX_LOADING_TIMEOUT_SUMMARY.md)** — Loading timeout fix
- **[ADDRESS_TIMEOUT_FIX_SUMMARY.md](ADDRESS_TIMEOUT_FIX_SUMMARY.md)** — Address timeout fix
- **[XPUB_SWAPPING_LOADING_FIX.md](XPUB_SWAPPING_LOADING_FIX.md)** — XPUB swapping loading fix
- **[XPUB_SWITCH_TIMEOUT_FIX.md](XPUB_SWITCH_TIMEOUT_FIX.md)** — XPUB switch timeout fix

## Testing

When creating new documentation:
- **[TESTING_GUIDE.md](TESTING_GUIDE.md)** — Testing guidelines and strategies

1. **Create the file in this directory**: `docs/your-documentation.md`
2. **Use descriptive file names**: Use lowercase with hyphens (e.g., `api-guide.md`)
3. **Update this README**: Add a link to your new documentation file
4. **Follow markdown best practices**: Use proper headings, formatting, and structure
## Marketing & SEO

## Related Documentation
- **[SEO_STRATEGY.md](SEO_STRATEGY.md)** — SEO guidelines and optimization
- **[ai-training-content.md](ai-training-content.md)** — AI training content and SEO keywords

For technical documentation about the codebase:
- See [AGENTS.md](../AGENTS.md) for project architecture and structure
- See [README.md](../README.md) for setup and usage instructions
- See [CONTRIBUTING.md](../CONTRIBUTING.md) for contribution guidelines
## Archive

- **[archive/](archive/)** — Older documentation kept for reference

---

**Built with ❤️ by BitSleuth**
## Adding New Documentation

1. Create the file in this directory: `docs/your-documentation.md`
2. Use lowercase kebab-case for file names (e.g., `api-guide.md`)
3. Add a link to this README under the appropriate section
4. See [CONTRIBUTING.md](../CONTRIBUTING.md) for full documentation standards

## Related

- [README.md](../README.md) — Project overview and setup
- [CONTRIBUTING.md](../CONTRIBUTING.md) — Contribution guidelines
- [AGENTS.md](../AGENTS.md) — Project architecture and structure
- [SECURITY.md](../SECURITY.md) — Security policy
- [CHANGELOG.md](../CHANGELOG.md) — Release history
Loading