Reviews that follow the docs you follow. Point CloudAEye at the official documentation for the frameworks and packages you use, like FastAPI or CNCF projects, and it uses that context when it reviews your pull requests.
Improve review accuracy by providing documentation to your technology stack or APIs.
payments-api / Tech Stack
Technologies in this repository
| Technology | Documentation |
|---|---|
| FastAPI | fastapi.tiangolo.com |
| Kubernetes | kubernetes.io/docs/ |
| nginx | nginx.org/en/docs/ |
On the next pull request
payments/api.py:31Medium
requests.get() is called inside an
async def endpoint. The FastAPI docs say a
blocking call there stalls every other request; declare
the endpoint with def, or use an async
client.
The official docs for your stack become context the review can use.
A model's idea of a framework can be generic or out of date. Point CloudAEye at the official docs for the technologies you use, and reviews check your code against how they are meant to be used.
Add the official docs for the frameworks, CNCF projects, and packages your code depends on. Findings then match how each one is meant to be used.
CloudAEye shows the technologies used in each repository. Add one or more documentation URLs to any of them.
Remove a technology a repository no longer uses, so its docs stop shaping the review.
Documentation adds what the code graph cannot read: how a library is meant to be used, not just how your code calls it.
Add documentation for a repository's technologies from the CloudAEye console.
Read the setup guide