nanobot/docs/README.md

31 lines
1.2 KiB
Markdown

# nanobot Docs
For the latest documentation, visit [nanobot.wiki](https://nanobot.wiki/docs/0.1.5/getting-started/nanobot-overview).
The pages in this directory track the current repository and may move faster than the published website.
## Core Docs
| Topic | Repo docs |
|---|---|
| Install and quick start | [`quick-start.md`](./quick-start.md) |
| Chat apps | [`chat-apps.md`](./chat-apps.md) |
| Agent social network | [`agent-social-network.md`](./agent-social-network.md) |
| Configuration | [`configuration.md`](./configuration.md) |
| Multiple instances | [`multiple-instances.md`](./multiple-instances.md) |
| CLI reference | [`cli-reference.md`](./cli-reference.md) |
| In-chat commands | [`chat-commands.md`](./chat-commands.md) |
| OpenAI-compatible API | [`openai-api.md`](./openai-api.md) |
| Deployment | [`deployment.md`](./deployment.md) |
## Advanced Docs
| Topic | Repo docs |
|---|---|
| Memory | [`memory.md`](./memory.md) |
| Python SDK | [`python-sdk.md`](./python-sdk.md) |
| Channel plugin guide | [`channel-plugin-guide.md`](./channel-plugin-guide.md) |
| WebSocket channel | [`websocket.md`](./websocket.md) |
| Custom tools | [`my-tool.md`](./my-tool.md) |