harald/zeroclaw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Merge pull request #1012 from zeroclaw-labs/fix/docs-collection-indexes

Browse source 
docs: enhance getting-started, hardware, and project collection indexes
This commit is contained in:
Alex Gorevski 2026-02-19 16:00:56 -08:00 • committed by GitHub
commit 88a036304d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 17 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/getting-started/README.md
View file

@ -8,6 +8,15 @@ For first-time setup and quick orientation.
2. One-click setup and dual bootstrap mode: [../one-click-bootstrap.md](../one-click-bootstrap.md)
3. Find commands by tasks: [../commands-reference.md](../commands-reference.md)
## Choose Your Path
| Scenario | Command |
|----------|---------|
| I have an API key, want fastest setup | `zeroclaw onboard --api-key sk-... --provider openrouter` |
| I want guided prompts | `zeroclaw onboard --interactive` |
| Config exists, just fix channels | `zeroclaw onboard --channels-only` |
| Using subscription auth | See [Subscription Auth](../../README.md#subscription-auth-openai-codex--claude-code) |
## Onboarding and Validation
- Quick onboarding: `zeroclaw onboard --api-key "sk-..." --provider openrouter`

2
docs/hardware/README.md
View file

@ -2,6 +2,8 @@
For board integration, firmware flow, and peripheral architecture.
ZeroClaw's hardware subsystem enables direct control of microcontrollers and peripherals via the `Peripheral` trait. Each board exposes tools for GPIO, ADC, and sensor operations, allowing agent-driven hardware interaction on boards like STM32 Nucleo, Raspberry Pi, and ESP32. See [hardware-peripherals-design.md](../hardware-peripherals-design.md) for the full architecture.
## Entry Points
- Architecture and peripheral model: [../hardware-peripherals-design.md](../hardware-peripherals-design.md)

8
docs/project/README.md
View file

@ -8,6 +8,10 @@ Time-bound project status snapshots for planning documentation and operations wo
## Scope
Use snapshots to understand changing PR/issue pressure and prioritize doc maintenance.
Project snapshots are time-bound assessments of open PRs, issues, and documentation health. Use these to:
For stable classification of docs intent, use [../docs-inventory.md](../docs-inventory.md).
- Identify documentation gaps driven by feature work
- Prioritize docs maintenance alongside code changes
- Track evolving PR/issue pressure over time
For stable documentation classification (not time-bound), use [docs-inventory.md](../docs-inventory.md).