volcano-sh / volcano-sh/agentcube
Add More Technical Documentation for Developers and Contributors
Open
@vanshika2720 is already working on this.
Since Jun 25, 2026.
kind/enhancement
- Dominant language
- Go
- Stars
- 167
- Forks
- 88
- Avg merge
- 44m
- Merged PRs (30d)
- 1
Description
What would you like to be added:
Add more technical documentation to the AgentCube website, including:
- Detailed architecture documentation explaining core components and their interactions
- Design decisions and project internals
- MCP integration architecture and workflows
- API and SDK documentation with examples
- Deployment architecture and infrastructure setup guides
- Developer guides for extending AgentCube with new features or integrations
- Component-level documentation and sequence diagrams
- Troubleshooting and debugging guides for developers
Why is this needed:
While the current documentation helps users get started, there is limited information available for contributors and developers who want to understand the project’s internals.
More technical documentation would:
- Make it easier for new contributors to onboard and contribute effectively.
- Help developers understand the architecture and design decisions behind AgentCube.
- Reduce the time spent exploring the codebase to understand system behavior.
- Improve maintainability by documenting important technical concepts and workflows.
- Enable the community to build extensions, integrations, and new features with greater confidence.
Comprehensive technical documentation is essential for the long-term growth and sustainability of an open-source project, especially as the codebase and contributor community continue to expand.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.