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
This commit is contained in:
Kadic Mirzet
parent
6a36c3c372
commit
d6779796ea
7 changed files with 22 additions and 49 deletions
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -277,7 +277,7 @@ Include:
|
|||
|
||||
### Issue Template
|
||||
|
||||
```markdown
|
||||
~~~markdown
|
||||
## Description
|
||||
[Describe the bug]
|
||||
|
||||
|
|
@ -301,7 +301,7 @@ Include:
|
|||
```
|
||||
[paste relevant logs]
|
||||
```
|
||||
```
|
||||
~~~
|
||||
|
||||
## Feature Requests
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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!
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue