You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
-**[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
293
285
294
286
---
295
287
@@ -329,7 +321,7 @@ hyperagent/
329
321
-**LLM**: Google Gemini, OpenAI GPT-4
330
322
-**Security**: Slither, Mythril, Echidna
331
323
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).
> 📖 **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).
392
384
393
385
---
394
386
@@ -400,15 +392,15 @@ We welcome contributions from the community! HyperAgent is an open-source projec
400
392
401
393
1.**Fork** the repository
402
394
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))
404
396
4.**Write tests** for your changes
405
397
5.**Commit** your changes (`git commit -m 'feat: Add amazing feature'`)
406
398
6.**Push** to your branch (`git push origin feature/amazing-feature`)
407
399
7.**Open a Pull Request**
408
400
409
401
### Development Guidelines
410
402
411
-
- Follow the [Standard Development Workflow](./.cursor/rules/dev-workflow.mdc)
403
+
- Follow the standard development workflow (see [CONTRIBUTING.md](./CONTRIBUTING.md))
412
404
- Write tests before implementation (TDD approach)
413
405
- Follow code style guidelines (PEP 8, type hints, async/await)
414
406
- Update documentation for new features
@@ -418,7 +410,7 @@ We welcome contributions from the community! HyperAgent is an open-source projec
418
410
419
411
Please note we have a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
- ❓ **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
0 commit comments