https://github.com/agentsystems/docs
Documentation for AgentSystems platform
https://github.com/agentsystems/docs
Last synced: 5 months ago
JSON representation
Documentation for AgentSystems platform
- Host: GitHub
- URL: https://github.com/agentsystems/docs
- Owner: agentsystems
- License: mit
- Created: 2025-09-19T01:58:55.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-12-06T01:27:13.000Z (7 months ago)
- Last Synced: 2025-12-08T17:59:33.896Z (7 months ago)
- Language: MDX
- Homepage: https://docs.agentsystems.ai/
- Size: 714 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AgentSystems Documentation
Documentation for AgentSystems - self-hosted platform for discovering and running AI agents.
This repository contains documentation for various components, including:
- Platform installation and setup
- Configuration guides (models, credentials, registries)
- Running and managing agents
- Building custom agents
- API reference
**[Visit the documentation](https://docs.agentsystems.ai)** *(in development)*
## Development
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
```
npm i -g mint
```
Run the following command at the root of your documentation, where your `docs.json` is located:
```
mint dev
```
View your local preview at `http://localhost:3000`.
## Publishing changes
Changes to the documentation are typically deployed via CI/CD when merged to the main branch.
## Documentation Structure
### Phase 1: Core Documentation (14 pages)
The documentation is organized into sections that guide users from installation through agent deployment:
```
docs/
├── 🚀 Getting Started (3 pages)
│ ├── index.mdx # Introduction
│ ├── quickstart.mdx # 5-Minute Quick Start with System Requirements
│ └── key-concepts.mdx # How Components Work Together
│
├── ⚙️ Configuration (5 pages)
│ ├── index.mdx # Configuration Overview & Dependency Chain
│ ├── credentials.mdx # Step 1: API Keys & Environment Variables
│ ├── model-connections.mdx # Step 2: AI Provider Connections
│ ├── registry-connections.mdx # Step 3: Container Registries
│ └── agents.mdx # Step 4: Agent Deployment
│
├── 📖 User Guide (5 pages)
│ ├── cli-commands.mdx # SDK Command Reference
│ ├── running-agents.mdx # Execute Agents via UI
│ ├── artifacts.mdx # Artifacts & File I/O
│ ├── audit-logs.mdx # Hash-Chained Audit Trail
│ └── agent-index.mdx # Future Agent Discovery Platform
│
└── 🚀 Deploy Agents (1 page)
└── quickstart.mdx # Coming Soon
```
### Future Phases
Additional documentation will be added as the platform matures:
- API Reference with OpenAPI specifications
- Advanced topics (authentication, UI customization)
- Additional examples and tutorials
- Platform administration guides
- Troubleshooting and debugging
## Contributing
We welcome contributions to improve the documentation! Please:
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request
## Need help?
### Troubleshooting
- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
### Resources
- [AgentSystems GitHub](https://github.com/agentsystems/agentsystems)
- [Mintlify documentation](https://mintlify.com/docs)