Skip to content

Commit 5a7f966

Browse files
committed
docs: add comprehensive production documentation in docs/
- Add QUICK_START.md for getting started guide - Add DEPLOYMENT.md for production deployment instructions - Add CONFIGURATION.md for complete configuration reference - Add API_REFERENCE.md for REST API documentation - Add TROUBLESHOOTING.md for common issues and solutions - Add NETWORKS.md for supported networks and features - Update README.md to reference new documentation files
1 parent 9ff70ba commit 5a7f966

File tree

7 files changed

+2141
-28
lines changed

7 files changed

+2141
-28
lines changed

README.md

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ curl http://localhost:8000/api/v1/health/
167167
# Expected response: {"status": "healthy", ...}
168168
```
169169

170-
> 📖 **Need more help?** See the [Getting Started Guide](./GUIDE/GETTING_STARTED.md) for detailed setup instructions.
170+
> 📖 **Need more help?** See the [Contributing Guide](./CONTRIBUTING.md) for detailed setup instructions.
171171
172172
---
173173

@@ -257,39 +257,31 @@ status = httpx.get(
257257
print(f"Status: {status['status']}, Progress: {status['progress_percentage']}%")
258258
```
259259

260-
> 📚 **More Examples:** See [Usage Examples](./GUIDE/GETTING_STARTED.md#example-workflows) for additional use cases.
260+
> 📚 **More Examples:** See the [Usage](#-usage) section above for additional use cases.
261261
262262
---
263263

264264
## 📚 Documentation
265265

266266
### Getting Started
267267

268-
- **[Getting Started Guide](./GUIDE/GETTING_STARTED.md)** - Complete setup and first contract generation
269-
- **[Developer Guide](./GUIDE/DEVELOPER_GUIDE.md)** - Development environment and workflow
270-
- **[User Guide](./GUIDE/USER_GUIDE.md)** - End-user task-oriented instructions
271-
- **[API Documentation](./GUIDE/API.md)** - Complete API reference
268+
- **[Quick Start Guide](./docs/QUICK_START.md)** - Get up and running in minutes
269+
- **[Configuration Reference](./docs/CONFIGURATION.md)** - Complete configuration options
270+
- **[Deployment Guide](./docs/DEPLOYMENT.md)** - Production deployment instructions
271+
- **[Networks Guide](./docs/NETWORKS.md)** - Supported networks and features
272272

273-
### How-To Guides
273+
### API & Integration
274274

275-
- **[Deployment Guide](./GUIDE/DEPLOYMENT.md)** - Deploy contracts to blockchain
276-
- **[Docker Setup](./GUIDE/DOCKER.md)** - Run HyperAgent with Docker
277-
- **[Hyperion PEF Guide](./docs/HYPERION_PEF_GUIDE.md)** - Parallel batch deployment
278-
- **[MetisVM Optimization](./docs/METISVM_OPTIMIZATION.md)** - MetisVM-specific features
279-
- **[Troubleshooting](./docs/TROUBLESHOOTING.md)** - Common issues and solutions
280-
281-
### Technical Documentation
282-
283-
- **[Architecture Diagrams](./docs/ARCHITECTURE_DIAGRAMS.md)** - System architecture and patterns
284-
- **[Complete Technical Specification](./docs/complete-tech-spec.md)** - Full technical details
285-
- **[Network Compatibility](./docs/NETWORK_COMPATIBILITY.md)** - Supported networks and features
286-
- **[Testing Setup Guide](./docs/TESTING_SETUP_GUIDE.md)** - Testing configuration and examples
275+
- **[API Reference](./docs/API_REFERENCE.md)** - Complete REST API documentation
276+
- **[Troubleshooting Guide](./docs/TROUBLESHOOTING.md)** - Common issues and solutions
287277

288278
### Contributing
289279

290-
- **[Contributing Guidelines](./CONTRIBUTING.md)** - How to contribute
291-
- **[Collaborator Guide](./GUIDE/COLLABORATOR_GUIDE.md)** - Contributor workflow
292-
- **[Code of Conduct](./CODE_OF_CONDUCT.md)** - Community standards
280+
- **[Contributing Guidelines](./CONTRIBUTING.md)** - How to contribute and development workflow
281+
- **[Code of Conduct](./CODE_OF_CONDUCT.md)** - Community standards and expectations
282+
- **[Security Policy](./SECURITY.md)** - Security guidelines and vulnerability reporting
283+
- **[Changelog](./CHANGELOG.md)** - Version history and release notes
284+
- **[Branch Workflow](./BRANCH_WORKFLOW.md)** - Git branching strategy and workflow
293285

294286
---
295287

@@ -329,7 +321,7 @@ hyperagent/
329321
- **LLM**: Google Gemini, OpenAI GPT-4
330322
- **Security**: Slither, Mythril, Echidna
331323

332-
> 📖 **Detailed Architecture:** See [Architecture Diagrams](./docs/ARCHITECTURE_DIAGRAMS.md) for comprehensive system design.
324+
> 📖 **Detailed Architecture:** See the [Architecture](#-architecture) section above for system design overview. For comprehensive architecture documentation, refer to the [development branch](https://github.com/JustineDevs/HyperAgent/tree/development).
333325
334326
---
335327

@@ -388,7 +380,7 @@ tests/
388380
└── load/ # Load testing scripts
389381
```
390382

391-
> 📖 **Testing Guide:** See [Testing Setup Guide](./docs/TESTING_SETUP_GUIDE.md) for complete testing documentation.
383+
> 📖 **Testing Guide:** See the [Testing](#-testing) section above for testing commands. For comprehensive testing documentation, refer to the [development branch](https://github.com/JustineDevs/HyperAgent/tree/development).
392384
393385
---
394386

@@ -400,15 +392,15 @@ We welcome contributions from the community! HyperAgent is an open-source projec
400392

401393
1. **Fork** the repository
402394
2. **Create a feature branch** (`git checkout -b feature/amazing-feature`)
403-
3. **Make your changes** following our [Development Workflow](./.cursor/rules/dev-workflow.mdc)
395+
3. **Make your changes** following our development workflow (see [CONTRIBUTING.md](./CONTRIBUTING.md))
404396
4. **Write tests** for your changes
405397
5. **Commit** your changes (`git commit -m 'feat: Add amazing feature'`)
406398
6. **Push** to your branch (`git push origin feature/amazing-feature`)
407399
7. **Open a Pull Request**
408400

409401
### Development Guidelines
410402

411-
- Follow the [Standard Development Workflow](./.cursor/rules/dev-workflow.mdc)
403+
- Follow the standard development workflow (see [CONTRIBUTING.md](./CONTRIBUTING.md))
412404
- Write tests before implementation (TDD approach)
413405
- Follow code style guidelines (PEP 8, type hints, async/await)
414406
- Update documentation for new features
@@ -418,7 +410,7 @@ We welcome contributions from the community! HyperAgent is an open-source projec
418410

419411
Please note we have a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
420412

421-
> 📖 **Contributing Guide:** See [CONTRIBUTING.md](./CONTRIBUTING.md) and [Collaborator Guide](./GUIDE/COLLABORATOR_GUIDE.md) for detailed contribution guidelines.
413+
> 📖 **Contributing Guide:** See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed contribution guidelines.
422414
423415
---
424416

@@ -429,7 +421,7 @@ Please note we have a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating,
429421
- 📖 **Documentation** - Check our [documentation](#-documentation) section
430422
- 🐛 **Bug Reports** - Open an issue on [GitHub Issues](https://github.com/JustineDevs/HyperAgent/issues)
431423
- 💡 **Feature Requests** - Submit via [GitHub Issues](https://github.com/JustineDevs/HyperAgent/issues)
432-
-**Questions** - Check [Troubleshooting Guide](./docs/TROUBLESHOOTING.md)
424+
-**Questions** - Check [GitHub Issues](https://github.com/JustineDevs/HyperAgent/issues) or refer to the [development branch](https://github.com/JustineDevs/HyperAgent/tree/development) for troubleshooting guides
433425

434426
### Community
435427

0 commit comments

Comments
 (0)