Merge pull request #1012 from zeroclaw-labs/fix/docs-collection-indexes
docs: enhance getting-started, hardware, and project collection indexes
This commit is contained in:
commit
88a036304d
3 changed files with 17 additions and 2 deletions
|
|
@ -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)
|
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)
|
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
|
## Onboarding and Validation
|
||||||
|
|
||||||
- Quick onboarding: `zeroclaw onboard --api-key "sk-..." --provider openrouter`
|
- Quick onboarding: `zeroclaw onboard --api-key "sk-..." --provider openrouter`
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
|
|
||||||
For board integration, firmware flow, and peripheral architecture.
|
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
|
## Entry Points
|
||||||
|
|
||||||
- Architecture and peripheral model: [../hardware-peripherals-design.md](../hardware-peripherals-design.md)
|
- Architecture and peripheral model: [../hardware-peripherals-design.md](../hardware-peripherals-design.md)
|
||||||
|
|
|
||||||
|
|
@ -8,6 +8,10 @@ Time-bound project status snapshots for planning documentation and operations wo
|
||||||
|
|
||||||
## Scope
|
## 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).
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue