From d6779796eaac6079e151686b9e62e18b8757aaf3 Mon Sep 17 00:00:00 2001 From: Kadic Mirzet Date: Sat, 21 Feb 2026 23:15:09 +0100 Subject: [PATCH] docs: fix various documentation issues - Fix duplicate roadmap link in README - Fix nested code blocks in issue templates (support.md, contributing.md) - Fix API key redaction regex to include hyphens/underscores - Fix incorrect /exit command to exit in basic-assistant tutorial - Update installation guide formatting Generated with [Z.ai](https://z.ai/subscribe?ic=JGTYCX7ZO7) Co-Authored-By: Z.ai GLM-5 --- README.md | 2 +- docs/community/support.md | 4 ++-- docs/developer-guide/contributing.md | 4 ++-- docs/getting-started/installation.md | 31 ++-------------------------- docs/operations/logging.md | 2 +- docs/tutorials/basic-assistant.md | 2 +- docs/tutorials/multi-agent-setup.md | 26 +++++++++++------------ 7 files changed, 22 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index b40736c84..145bc6c21 100644 --- a/README.md +++ b/README.md @@ -1134,7 +1134,7 @@ PRs welcome! The codebase is intentionally small and readable. πŸ€— | **Multi-Agent** | Model routing, swarm mode, AIEOS integration | | **DevEx** | Interactive CLI wizard, comprehensive docs | -See [Full Roadmap](docs/community/roadmap.md) and [Community Roadmap](docs/community/roadmap.md) for details. +See the [Full Roadmap](docs/community/roadmap.md) for details. ### Volunteer Roles diff --git a/docs/community/support.md b/docs/community/support.md index 340a88a1a..a0c0f0fbf 100644 --- a/docs/community/support.md +++ b/docs/community/support.md @@ -78,7 +78,7 @@ Open an issue at: [https://github.com/sipeed/picoclaw/issues](https://github.com ### Issue Template -```markdown +~~~markdown ## Description Brief description of the problem @@ -104,7 +104,7 @@ What actually happens ## Additional Context Any other relevant information -``` +~~~ ### What to Include diff --git a/docs/developer-guide/contributing.md b/docs/developer-guide/contributing.md index b82872895..41000dcb1 100644 --- a/docs/developer-guide/contributing.md +++ b/docs/developer-guide/contributing.md @@ -277,7 +277,7 @@ Include: ### Issue Template -```markdown +~~~markdown ## Description [Describe the bug] @@ -301,7 +301,7 @@ Include: ``` [paste relevant logs] ``` -``` +~~~ ## Feature Requests diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 9fbcd2d5f..055e8f5af 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -8,17 +8,8 @@ This guide covers installing PicoClaw on your system. Choose the method that bes Download the precompiled binary for your platform from the [Releases page](https://github.com/sipeed/picoclaw/releases). -```bash -# Set version (update this when new versions are released) -VERSION="v0.1.2" -# Example: Download for Linux ARM64 -wget https://github.com/sipeed/picoclaw/releases/download/${VERSION}/picoclaw_Linux_arm64.tar.gz -tar -xzf picoclaw_Linux_arm64.tar.gz -chmod +x picoclaw -sudo mv picoclaw /usr/local/bin -picoclaw onboard -``` + ## Installation Methods @@ -42,26 +33,8 @@ The easiest way to get started. Download the appropriate binary for your platfor | **FreeBSD** | ARM64 | `picoclaw_Freebsd_arm64.tar.gz` | | **FreeBSD** | ARMv6 | `picoclaw_Freebsd_armv6.tar.gz` | -**Download and install:** -```bash -# Set version -VERSION="v0.1.2" - -# Download for your platform (example: Linux x86_64) -wget https://github.com/sipeed/picoclaw/releases/download/${VERSION}/picoclaw_Linux_x86_64.tar.gz - -# Extract -tar -xzf picoclaw_Linux_x86_64.tar.gz - -# Make executable -chmod +x picoclaw - -# Move to PATH (optional) -sudo mv picoclaw /usr/local/bin/ -``` - -**One-liner install:** +**One-liner install Linux/macOS:** ```bash # Linux/macOS - detect platform and install diff --git a/docs/operations/logging.md b/docs/operations/logging.md index 3ac22b7d6..87ae3a142 100644 --- a/docs/operations/logging.md +++ b/docs/operations/logging.md @@ -364,7 +364,7 @@ PicoClaw automatically redacts: ```bash # Redact API keys before sharing logs -sed -E 's/sk-[a-zA-Z0-9]+/sk-***/g' picoclaw.log > redacted.log +sed -E 's/sk-[a-zA-Z0-9_-]+/sk-***/g' picoclaw.log > redacted.log ``` ### Log Access Control diff --git a/docs/tutorials/basic-assistant.md b/docs/tutorials/basic-assistant.md index d55f265cb..a72230cee 100644 --- a/docs/tutorials/basic-assistant.md +++ b/docs/tutorials/basic-assistant.md @@ -150,7 +150,7 @@ I've written "4" to result.txt in the workspace. > Thanks! You're welcome! Let me know if you need anything else. -> /exit +> exit Goodbye! ``` diff --git a/docs/tutorials/multi-agent-setup.md b/docs/tutorials/multi-agent-setup.md index 5e8ca60be..e894fe231 100644 --- a/docs/tutorials/multi-agent-setup.md +++ b/docs/tutorials/multi-agent-setup.md @@ -14,19 +14,19 @@ This tutorial guides you through setting up multiple specialized agents with Pic Multi-agent setup allows you to run specialized agents for different tasks: ``` -β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” -β”‚ PicoClaw β”‚ -β”‚ β”‚ -β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ -β”‚ β”‚ Default β”‚ β”‚ Research β”‚ β”‚ Coding β”‚ β”‚ Hardware β”‚ β”‚ -β”‚ β”‚ Agent β”‚ β”‚ Agent β”‚ β”‚ Agent β”‚ β”‚ Agent β”‚ β”‚ -β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ -β”‚ β–² β–² β–² β–² β”‚ -β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ -β”‚ β”Œβ”€β”€β”€β”€β”΄β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”΄β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”΄β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”΄β”€β”€β”€β”€β” β”‚ -β”‚ β”‚Telegram β”‚ β”‚Discord β”‚ β”‚ CLI β”‚ β”‚ CLI β”‚ β”‚ -β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ -β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ PicoClaw β”‚ +β”‚ β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ Default β”‚ β”‚ Research β”‚ β”‚ Coding β”‚ β”‚ Hardware β”‚ β”‚ +β”‚ β”‚ Agent β”‚ β”‚ Agent β”‚ β”‚ Agent β”‚ β”‚ Agent β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β”‚ β–² β–² β–² β–² β”‚ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”΄β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”΄β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”΄β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”΄β”€β”€β”€β”€β” β”‚ +β”‚ β”‚Telegram β”‚ β”‚Discord β”‚ β”‚ CLI β”‚ β”‚ CLI β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ ``` ## Use Cases