diff --git a/README.md b/README.md index 2d785f1d..b23b046b 100644 --- a/README.md +++ b/README.md @@ -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 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 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 Docker or Linux service deployment? See [Deployment](./docs/deployment.md) ## 🏗️ 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. -- 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) -- 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) +- 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) +- 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) ## 🤝 Contribute & Roadmap diff --git a/docs/README.md b/docs/README.md index 5158f802..6a3c9bd0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,30 +1,34 @@ # 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. ## 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) | +Start here for setup, everyday usage, and deployment. + +| Topic | Repo docs | What it covers | +|---|---|---| +| Install and quick start | [`quick-start.md`](./quick-start.md) | Installation, onboarding, and first-run setup | +| Chat apps | [`chat-apps.md`](./chat-apps.md) | Connect nanobot to Telegram, Discord, WeChat, and more | +| Agent social network | [`agent-social-network.md`](./agent-social-network.md) | Join external agent communities from nanobot | +| Configuration | [`configuration.md`](./configuration.md) | Providers, tools, channels, MCP, and runtime settings | +| Multiple instances | [`multiple-instances.md`](./multiple-instances.md) | Run isolated bots with separate configs and workspaces | +| CLI reference | [`cli-reference.md`](./cli-reference.md) | Core CLI commands and common entrypoints | +| 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 -| 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) | +Use these when you want deeper customization, integration, or extension details. + +| Topic | Repo docs | What it covers | +|---|---|---| +| Memory | [`memory.md`](./memory.md) | How nanobot stores, consolidates, and restores memory | +| Python SDK | [`python-sdk.md`](./python-sdk.md) | Use nanobot programmatically from Python | +| 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 |