Grayscale/nanobot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README and docs for clarity and consistency

Browse Source
This commit is contained in:
Xubin Ren
2026-04-19 19:25:05 +08:00
committed by Xubin Ren
parent 8ff7b56cb2
commit 53fb3c199a
2 changed files with 30 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -7
View File
@@ -175,9 +175,9 @@ nanobot agent
``` ```
- Want different LLM providers, web search, MCP, security settings, or more config options? See [`Configuration`](./docs/configuration.md) - Want different LLM providers, web search, MCP, security settings, or more config options? See [Configuration](./docs/configuration.md)
- Want to run nanobot in chat apps like Telegram, Discord, WeChat or Feishu? See [`Chat Apps`](./docs/chat-apps.md) - Want to run nanobot in chat apps like Telegram, Discord, WeChat or Feishu? See [Chat Apps](./docs/chat-apps.md)
- Want Docker or Linux service deployment? See [`Deployment`](./docs/deployment.md) - Want Docker or Linux service deployment? See [Deployment](./docs/deployment.md)
## 🏗️ Architecture ## 🏗️ Architecture
@@ -214,10 +214,10 @@ nanobot agent
Browse the [repo docs](./docs/README.md) for the latest features and GitHub development version, or visit [nanobot.wiki](https://nanobot.wiki/docs/latest/getting-started/nanobot-overview) for the stable release documentation. Browse the [repo docs](./docs/README.md) for the latest features and GitHub development version, or visit [nanobot.wiki](https://nanobot.wiki/docs/latest/getting-started/nanobot-overview) for the stable release documentation.
- Talk to your nanobot with familiar chat apps: [`Chat Apps`](./docs/chat-apps.md) - Talk to your nanobot with familiar chat apps: [Chat Apps](./docs/chat-apps.md)
- Configure providers, web search, MCP, and runtime behavior: [`Configuration`](./docs/configuration.md) - Configure providers, web search, MCP, and runtime behavior: [Configuration](./docs/configuration.md)
- Integrate nanobot with local tools and automations: [`OpenAI-Compatible API`](./docs/openai-api.md) · [`Python SDK`](./docs/python-sdk.md) - Integrate nanobot with local tools and automations: [OpenAI-Compatible API](./docs/openai-api.md) · [Python SDK](./docs/python-sdk.md)
- Run nanobot with Docker or as a Linux service: [`Deployment`](./docs/deployment.md) - Run nanobot with Docker or as a Linux service: [Deployment](./docs/deployment.md)
## 🤝 Contribute & Roadmap ## 🤝 Contribute & Roadmap
docs/README.md
+23 -19
View File
@@ -1,30 +1,34 @@
# nanobot Docs # nanobot Docs
For the latest documentation, visit [nanobot.wiki](https://nanobot.wiki/docs/0.1.5/getting-started/nanobot-overview). For the latest documentation, visit [nanobot.wiki](https://nanobot.wiki/docs/latest/getting-started/nanobot-overview).
The pages in this directory track the current repository and may move faster than the published website. The pages in this directory track the current repository and may move faster than the published website.
## Core Docs ## Core Docs
| Topic | Repo docs | Start here for setup, everyday usage, and deployment.
|---|---|
| Install and quick start | [`quick-start.md`](./quick-start.md) | | Topic | Repo docs | What it covers |
| Chat apps | [`chat-apps.md`](./chat-apps.md) | |---|---|---|
| Agent social network | [`agent-social-network.md`](./agent-social-network.md) | | Install and quick start | [`quick-start.md`](./quick-start.md) | Installation, onboarding, and first-run setup |
| Configuration | [`configuration.md`](./configuration.md) | | Chat apps | [`chat-apps.md`](./chat-apps.md) | Connect nanobot to Telegram, Discord, WeChat, and more |
| Multiple instances | [`multiple-instances.md`](./multiple-instances.md) | | Agent social network | [`agent-social-network.md`](./agent-social-network.md) | Join external agent communities from nanobot |
| CLI reference | [`cli-reference.md`](./cli-reference.md) | | Configuration | [`configuration.md`](./configuration.md) | Providers, tools, channels, MCP, and runtime settings |
| In-chat commands | [`chat-commands.md`](./chat-commands.md) | | Multiple instances | [`multiple-instances.md`](./multiple-instances.md) | Run isolated bots with separate configs and workspaces |
| OpenAI-compatible API | [`openai-api.md`](./openai-api.md) | | CLI reference | [`cli-reference.md`](./cli-reference.md) | Core CLI commands and common entrypoints |
| Deployment | [`deployment.md`](./deployment.md) | | In-chat commands | [`chat-commands.md`](./chat-commands.md) | Slash commands and periodic task behavior |
| OpenAI-compatible API | [`openai-api.md`](./openai-api.md) | Local API endpoints, request format, and file uploads |
| Deployment | [`deployment.md`](./deployment.md) | Docker and Linux service setup |
## Advanced Docs ## Advanced Docs
| Topic | Repo docs | Use these when you want deeper customization, integration, or extension details.
|---|---|
| Memory | [`memory.md`](./memory.md) | | Topic | Repo docs | What it covers |
| Python SDK | [`python-sdk.md`](./python-sdk.md) | |---|---|---|
| Channel plugin guide | [`channel-plugin-guide.md`](./channel-plugin-guide.md) | | Memory | [`memory.md`](./memory.md) | How nanobot stores, consolidates, and restores memory |
| WebSocket channel | [`websocket.md`](./websocket.md) | | Python SDK | [`python-sdk.md`](./python-sdk.md) | Use nanobot programmatically from Python |
| Custom tools | [`my-tool.md`](./my-tool.md) | | Channel plugin guide | [`channel-plugin-guide.md`](./channel-plugin-guide.md) | Build and test custom chat channel plugins |
| WebSocket channel | [`websocket.md`](./websocket.md) | Real-time WebSocket access and protocol details |
| Custom tools | [`my-tool.md`](./my-tool.md) | Inspect and tune runtime state with the `my` tool |