Welcome to the ChainViz documentation! This directory contains all the documentation for the ChainViz Bitcoin blockchain analysis platform.
New to ChainViz? Start here!
- Installation Guide - Set up ChainViz on your system
- Quick Start Guide - Get up and running in 2 minutes
- Development Setup - Set up for development
Learn how to use ChainViz effectively.
- Tracing Guide - Complete guide to tracing Bitcoin transactions
- Heuristics Explained - Detailed explanation of analysis heuristics
- UI Guide - Complete guide to the user interface
- API Reference - Complete API documentation
Deploy ChainViz to production.
- Docker Guide - Deploy with Docker and Docker Compose
- AWS Deployment - Deploy to Amazon Web Services
- Auto-Deploy - Set up automated deployments
Having issues? We've got you covered.
- Common Issues - Solutions to common problems
- First time? → Quick Start Guide
- Want to trace transactions? → Tracing Guide
- Need help with the UI? → UI Guide
- Having problems? → Common Issues
- Setting up for development? → Development Setup
- Want to use the API? → API Reference
- Deploying to production? → Docker Guide
- Deploying to AWS? → AWS Deployment
- Setting up auto-deploy? → Auto-Deploy
- Using Docker? → Docker Guide
| Document | Description |
|---|---|
| Installation Guide | Set up ChainViz on your system |
| Quick Start Guide | Get up and running in 2 minutes |
| Development Setup | Set up for development |
| Document | Description |
|---|---|
| Tracing Guide | Complete guide to tracing Bitcoin transactions |
| Heuristics Explained | Detailed explanation of analysis heuristics |
| UI Guide | Complete guide to the user interface |
| API Reference | Complete API documentation |
| Document | Description |
|---|---|
| Docker Guide | Deploy with Docker and Docker Compose |
| AWS Deployment | Deploy to Amazon Web Services |
| Auto-Deploy | Set up automated deployments |
| Document | Description |
|---|---|
| Common Issues | Solutions to common problems |
...get started quickly → Quick Start Guide
...install ChainViz → Installation Guide
...trace Bitcoin transactions → Tracing Guide
...understand how heuristics work → Heuristics Explained
...use the UI effectively → UI Guide
...use the API → API Reference
...deploy with Docker → Docker Guide
...deploy to AWS → AWS Deployment
...set up auto-deploy → Auto-Deploy
...develop ChainViz → Development Setup
...fix a problem → Common Issues
All documentation follows these standards:
- Markdown format for easy reading
- Clear headings for navigation
- Code examples for practical usage
- Cross-references to related docs
- Troubleshooting sections for common issues
- Regular updates to keep current
Found an error or want to improve the docs?
- Fork the repository
- Make your changes
- Submit a pull request
We welcome contributions to improve the documentation!
- Documentation: Browse this directory
- Issues: Create an issue on GitHub
- Discussions: Join the discussion
Happy reading! 📚