Skip to content

docs: restructure README — hub-and-spoke pattern, fix accuracy#285

Merged
viettranx merged 2 commits intonextlevelbuilder:mainfrom
thieung:docs/readme-restructure
Mar 20, 2026
Merged

docs: restructure README — hub-and-spoke pattern, fix accuracy#285
viettranx merged 2 commits intonextlevelbuilder:mainfrom
thieung:docs/readme-restructure

Conversation

@thieung
Copy link
Contributor

@thieung thieung commented Mar 19, 2026

Summary

  • Restructure README from ~950 lines to ~350 lines following hub-and-spoke pattern (README as landing page, detailed docs in goclaw-docs)
  • Fix provider count from 13+ to 20+ (verified against cmd/gateway_providers.go: anthropic, openai, openrouter, groq, deepseek, gemini, mistral, xai, minimax, cohere, perplexity, dashscope, bailian, zai, zai-coding, ollama, ollama-cloud, claude-cli, codex, acp)
  • Fix "5-layer defense" marketing term to accurate "5-layer permission system" (gateway auth → global tool policy → per-agent → per-channel → owner-only) per internal/permissions/policy.go
  • Add missing feature highlights: Heartbeat System, Scheduling & Cron, Observability
  • Add Documentation table linking all goclaw-docs sections
  • Remove content duplicated with goclaw-docs: env vars, CLI commands, Docker compose details, Tailscale, browser pairing, security details, upgrading, project status

Test plan

  • Verify all goclaw-docs links resolve correctly on docs site
  • Confirm mermaid diagrams render on GitHub
  • Cross-check feature claims against current codebase

Restructure:
- Reduce README from ~950 to ~280 lines (hub-and-spoke pattern)
- Move Project Status to CHANGELOG.md
- Add hero section: centered title, tagline, description, badges
- Add nav links: Documentation, Quick Start, Twitter/X (OpenFang pattern)
- Add Documentation table linking all docs.goclaw.sh sections
- Replace 3 mermaid diagrams with static images for consistent rendering

Accuracy fixes:
- Fix provider count: 13+ → 20+ (verified from gateway_providers.go)
- Fix "5-layer defense" → 5-layer permission system per policy.go
- Add missing features: Heartbeat, Scheduling/Cron, Observability
- Fix all docs URLs to docs.goclaw.sh hash routing
- Add VPS $5 minimum 2GB RAM note for Docker

Internationalization (30 languages, ZeroClaw coverage):
zh-CN, ja, ko, vi, tl, es, pt, it, de, fr, ar, hi, ru, bn, he,
pl, cs, nl, tr, uk, id, th, ur, ro, sv, el, hu, fi, da, nb
- Keep product feature names in English: Extended Thinking, Heartbeat
- Vietnamese README hand-tuned for natural phrasing
@thieung thieung force-pushed the docs/readme-restructure branch from 510a29a to a805d55 Compare March 19, 2026 19:09
Keep all 30 language translations but declutter the project root.
Fix relative links (_statics/, cross-language, main README) for new location.
Update main README language selector to point to _readmes/.
@viettranx viettranx merged commit d9dffc6 into nextlevelbuilder:main Mar 20, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants