We welcome contributions to improve the Agno documentation! Please read our CONTRIBUTING.md for detailed guidelines on:
- How to set up your development environment
- Pull request and branch naming conventions
- Documentation structure and writing guidelines
- Testing and validation procedures
Install the Mintlify CLI to run documentation site locally:
npm i -g mint
Run the following command at the root of your documentation (where docs.json
is)
mint dev
Publish changes by pushing to the main branch
git add .
git commit -m "update message"
git push
- Run an
AgentOS
cookbook with the latest version of Agno - Run
curl -o reference-api/openapi.json http://localhost:7777/openapi.json
to download the latest API reference - Delete all files in the
reference-api/schema/
folder (the auto-generated files) - Run
npx @mintlify/scraping@latest openapi-file reference-api/openapi.json -o reference-api/schema
to generate the new API reference - Run
mint dev
to see the changes
- Mintlify dev isn't running - Run
mint update
it'll update dependencies. - Page loads as a 404 - Make sure you are running in a folder with
docs.json