Skip to content

Latest commit

 

History

History
144 lines (123 loc) · 9.42 KB

File metadata and controls

144 lines (123 loc) · 9.42 KB

ZeroClaw Documentation Inventory

This inventory classifies docs by intent so readers can quickly distinguish runtime-contract guides from design proposals.

Last reviewed: February 18, 2026.

Classification Legend

  • Current Guide/Reference: intended to match current runtime behavior
  • Policy/Process: collaboration or governance rules
  • Proposal/Roadmap: design exploration; may include hypothetical commands
  • Snapshot: time-bound operational report

Documentation Entry Points

Doc Type Audience
README.md Current Guide all readers
README.zh-CN.md Current Guide (localized) Chinese readers
README.ja.md Current Guide (localized) Japanese readers
README.ru.md Current Guide (localized) Russian readers
docs/README.md Current Guide (hub) all readers
docs/README.zh-CN.md Current Guide (localized hub) Chinese readers
docs/README.ja.md Current Guide (localized hub) Japanese readers
docs/README.ru.md Current Guide (localized hub) Russian readers
docs/SUMMARY.md Current Guide (unified TOC) all readers

Collection Index Docs

Doc Type Audience
docs/getting-started/README.md Current Guide new users
docs/reference/README.md Current Guide users/operators
docs/operations/README.md Current Guide operators
docs/security/README.md Current Guide operators/contributors
docs/hardware/README.md Current Guide hardware builders
docs/contributing/README.md Current Guide contributors/reviewers
docs/project/README.md Current Guide maintainers

Current Guides & References

Doc Type Audience
docs/one-click-bootstrap.md Current Guide users/operators
docs/commands-reference.md Current Reference users/operators
docs/providers-reference.md Current Reference users/operators
docs/channels-reference.md Current Reference users/operators
docs/config-reference.md Current Reference operators
docs/custom-providers.md Current Integration Guide integration developers
docs/zai-glm-setup.md Current Provider Setup Guide users/operators
docs/langgraph-integration.md Current Integration Guide integration developers
docs/operations-runbook.md Current Guide operators
docs/troubleshooting.md Current Guide users/operators
docs/network-deployment.md Current Guide operators
docs/mattermost-setup.md Current Guide operators
docs/adding-boards-and-tools.md Current Guide hardware builders
docs/arduino-uno-q-setup.md Current Guide hardware builders
docs/nucleo-setup.md Current Guide hardware builders
docs/hardware-peripherals-design.md Current Design Spec hardware contributors
docs/datasheets/nucleo-f401re.md Current Hardware Reference hardware builders
docs/datasheets/arduino-uno.md Current Hardware Reference hardware builders
docs/datasheets/esp32.md Current Hardware Reference hardware builders
docs/use-cases-and-hackathon-plan.md Current Guide (use cases + event plan) organizers, contributors, participants
docs/hackathon-content/README.md Current Guide (content kit index) organizers
docs/hackathon-content/judges-outreach.md Current Guide (judge recruitment) organizers
docs/hackathon-content/sponsors-outreach.md Current Guide (sponsor one-pager and email) organizers
docs/hackathon-content/builder-segments.md Current Guide (builder segments and channels) organizers
docs/hackathon-content/personas.md Current Guide (builder personas) organizers
docs/marketing/README.md Current Guide (marketing content kit index) organizers, contributors
docs/marketing/content-strategy.md Strategy (content pillars, cadence) organizers, contributors
docs/marketing/content-flows-and-devices.md Strategy (content flows per persona; device matrix) organizers, contributors
docs/marketing/content-use-cases-and-angles.md Strategy (surveillance, enterprise, IoT; Meta/glasses killer; job-displacement angle) organizers, contributors
docs/marketing/robotics-angle.md Strategy (robotics positioning, channels) organizers, contributors
docs/marketing/raspberry-pi-outreach.md Strategy (RPi communities, sellout events) organizers, contributors
docs/marketing/reddit-outreach.md Strategy (Reddit playbook, templates) organizers, contributors
docs/marketing/viral-tactics.md Strategy (shareable content, amplification) organizers, contributors
docs/marketing/openclaw-viral-playbook.md Strategy (OpenClaw viral tactics applied to ZeroClaw) organizers, contributors
docs/marketing/openclaw-pain-points.md Reference (OpenClaw pain points vs ZeroClaw advantages) organizers, contributors
docs/marketing/claude-trust-enterprise-narrative.md Strategy (why not to trust Claude; trust failures; ZeroClaw as alternative) organizers, contributors
docs/marketing/openclaw-security-incidents.md Reference (OpenClaw security incidents, CVEs, nightmare angles) organizers, contributors
docs/marketing/partner-pitch-security-brief.md Reference (partner pitch brief: incidents, ZeroClaw contrast, elevator pitch, content ideas) organizers, partners
docs/marketing/openclaw-viral-map.md Strategy (OpenClaw viral playbook → ZeroClaw mapping) organizers, contributors
docs/marketing/agentic-marketing-landscape.md Strategy (GTM landscape: survives vs dies; agentic distribution predictions) organizers, contributors
docs/marketing/enterprise-health-iot-playbook.md Strategy (enterprise, health, legal, IoT, wearables) organizers, contributors
docs/marketing/developer-content.md Strategy (developer content, blog outlines, templates) organizers, contributors
docs/marketing/rust-rise-narrative.md Strategy (marketing case for Rust; rise of Rust; content angles) organizers, contributors
docs/marketing/integrations-content-playbook.md Strategy (per-integration marketing, content, video outlines, scripts) organizers, contributors
docs/marketing/build-personas.md Reference (all build personas: goals, hooks, channels, content mapping) organizers, contributors
docs/marketing/viral-strategies-by-persona.md Strategy (viral tactics per persona: ideas, formats, channels) organizers, contributors
docs/marketing/influencer-and-narrative-angles.md Strategy (Brian Armstrong + x402, medical device, device sellout, agents for marketing) organizers, contributors
docs/marketing/x402-agents-paying-agents.md Strategy (ZeroClaw agents paying each other via x402; agent-to-agent micropayments) organizers, contributors
docs/marketing/crypto-community-outreach-dms.md Strategy (DM templates: Circle, Base, x402, DePIN, Superteam, Solana, wallet builders) organizers, contributors
docs/marketing/crypto-founders-narrative.md Strategy (ZeroClaw founders/contributors decade+ crypto; OpenClaw bans crypto; crypto builder onboarding) organizers, partners
docs/marketing/ai-hub-outreach.md Strategy (outreach for global AI hubs and communities: SF, NYC, London, Paris, Tokyo, etc.; experiment with ZeroClaw) organizers, contributors
docs/marketing/viral-tactics-money-making.md Strategy (viral tactics: making money, earning, monetization, side-hustle hooks) organizers, contributors
docs/marketing/sensitive-data-use-cases.md Strategy (viral use cases: sensitive info — health, legal, financial, HR, identity) organizers, contributors
docs/marketing/viral-opportunities-expanded.md Strategy (more viral opportunities: speedruns, calendar, platform-specific, memes, news jacking) organizers, contributors
docs/marketing/ai-devrel-strategy.md Strategy (AI DevRel: YouTube scripts, tutorial pipeline, creator collabs) organizers, contributors
docs/marketing/hosting-partnerships.md Strategy (hosting partnerships for 1-click deploy; outreach, content) organizers, contributors

Policy / Process Docs

Doc Type
docs/pr-workflow.md Policy
docs/reviewer-playbook.md Process
docs/ci-map.md Process
docs/actions-source-policy.md Policy

Proposal / Roadmap Docs

These are valuable context, but not strict runtime contracts.

Doc Type
docs/sandboxing.md Proposal
docs/resource-limits.md Proposal
docs/audit-logging.md Proposal
docs/agnostic-security.md Proposal
docs/frictionless-security.md Proposal
docs/security-roadmap.md Roadmap

Snapshot Docs

Doc Type
docs/project-triage-snapshot-2026-02-18.md Snapshot

Landing / Web

Doc Type Audience
landing/README.md Current Guide maintainers / deployers
landing/index.html Landing page visitors (marketing, SEO)

Maintenance Recommendations

  1. Update commands-reference whenever CLI surface changes.
  2. Update providers-reference when provider catalog/aliases/env vars change.
  3. Update channels-reference when channel support or allowlist semantics change.
  4. Keep snapshots date-stamped and immutable.
  5. Mark proposal docs clearly to avoid being mistaken for runtime contracts.
  6. Keep localized README/docs-hub links aligned when adding new core docs.
  7. Update docs/SUMMARY.md and collection indexes whenever new major docs are added.