Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

agno-agi/agno-docs

Open more actions menu
 
 

Repository files navigation

Agno Docs

Contributing

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

Development

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

Publishing Changes

Publish changes by pushing to the main branch

git add .
git commit -m "update message"
git push

How to generate a new API reference

  1. Run an AgentOS cookbook with the latest version of Agno
  2. Run curl -o reference-api/openapi.json http://localhost:7777/openapi.json to download the latest API reference
  3. Delete all files in the reference-api/schema/ folder (the auto-generated files)
  4. Run npx @mintlify/scraping@latest openapi-file reference-api/openapi.json -o reference-api/schema to generate the new API reference
  5. Run mint dev to see the changes

Troubleshooting

  • 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

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 24

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.