Docs/agentcube website#405
Conversation
vanshika2720
force-pushed
the
docs/agentcube-website
branch
from
dda1b9c to
894e9bf
Compare
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation for AgentCube and adds Prometheus metrics instrumentation to the PicoD sandbox daemon to track execution and HTTP request statistics. A review of the changes identified a broken link to a non-existent local development guide in the FAQ documentation.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
There was a problem hiding this comment.
Pull request overview
This PR expands the AgentCube Docusaurus website with substantially more developer/operator-focused documentation (getting started, configuration, API reference, developer guide pages, troubleshooting, FAQ, and feature overview). It also adds Prometheus metrics instrumentation to PicoD (including a new /metrics endpoint) and updates Go module dependencies accordingly.
Changes:
- Add and reorganize AgentCube website docs: getting started flow, configuration reference, API reference, troubleshooting, features, FAQ, and contributor guidance.
- Instrument PicoD with Prometheus collectors and a
/metricsendpoint; track HTTP request counts/latency and execution outcomes. - Update
go.modto includegithub.com/prometheus/client_golang.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| pkg/picod/server.go | Adds metrics middleware and exposes /metrics; updates gzip exclusions. |
| pkg/picod/metrics.go | Introduces Prometheus registry + Gin middleware/handler for metrics. |
| pkg/picod/metrics_test.go | Adds unit/integration-style tests validating metrics exposition and recording. |
| pkg/picod/execute.go | Tracks active executions and execution outcomes via new metrics; refactors working dir prep. |
| go.mod | Adds Prometheus client dependency as a direct requirement. |
| docs/agentcube/docs/getting-started.md | Expands install/quickstart steps and Helm configuration examples. |
| docs/agentcube/docs/configuration.md | Adds Helm/CRD configuration reference documentation. |
| docs/agentcube/docs/api-reference.md | Adds Router/Workload Manager/PicoD API reference and SDK reference. |
| docs/agentcube/docs/troubleshooting.md | Adds troubleshooting guide and diagnostic commands. |
| docs/agentcube/docs/features.md | Adds feature overview (warm pools, lifecycle, auth, HA, etc.). |
| docs/agentcube/docs/faq.md | Adds FAQ for users/developers. |
| docs/agentcube/docs/developer-guide/intro.md | Adds sidebar metadata and expands developer guide index. |
| docs/agentcube/docs/developer-guide/contributing.md | Adds contributor workflow and standards documentation. |
| docs/agentcube/docs/developer-guide/code-interpreter-using-langchain.md | Adds LangChain/LangGraph integration guide. |
| docs/agentcube/docs/developer-guide/code-interpreter-python-sdk.md | Adds Python SDK usage guide and examples. |
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #405 +/- ##
===========================================
+ Coverage 47.57% 58.57% +11.00%
===========================================
Files 30 37 +7
Lines 2819 3491 +672
===========================================
+ Hits 1341 2045 +704
+ Misses 1338 1237 -101
- Partials 140 209 +69
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Signed-off-by: Vanshika <pahalvanshikaa@gmail.com>
vanshika2720
force-pushed
the
docs/agentcube-website
branch
from
894e9bf to
c5a941c
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
- update SDK and LangChain guides to Python 3.10+ (actual SDK requirement) - remove invalid --set redis.password flag from Helm install example - clarify Redis auth: omit flag for passwordless dev, use secretName for prod - verify local-development.md link is valid (file exists) Signed-off-by: Vanshika <pahalvanshikaa@gmail.com>
- fix sessionTimeout in features.md to use 15m default, not hardcoded 5m - align lifecycle diagram labels to use CRD field names - remove AI-sounding boilerplate from page intros - run prettier on all modified doc files Signed-off-by: Vanshika <pahalvanshikaa@gmail.com>
|
|
||
| --- | ||
|
|
||
| ## Full Example: Math Agent Service (FastAPI) |
There was a problem hiding this comment.
can this example really work? We already got an example for langchain
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR expands the AgentCube documentation to better support developers and contributors who want to understand, extend, and maintain the project.
The changes add comprehensive technical documentation covering:
These additions improve contributor onboarding, reduce the learning curve for understanding the codebase, and provide a centralized reference for project internals and development workflows.
Which issue(s) this PR fixes:
Fixes #404
Special notes for your reviewer:
Does this PR introduce a user-facing change?: