docs: tested getting-started guide for new users#565
Merged
itskai-dev merged 1 commit intomainfrom Mar 1, 2026
Merged
Conversation
Every endpoint tested against a fresh Docker install. Covers: - Docker and source install paths - Team starter + team doctor - API examples (tasks, heartbeat, chat) - Agent connection instructions - Troubleshooting section Written after actually testing the product, not from assumptions.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
A getting-started guide I wrote after actually testing every endpoint against a fresh Docker install.
What I tested
docker run→ healthy in ~3s ✅/health→ returns status ok ✅/team/starter→ creates builder + ops agents ✅/health/team/doctor→ runs checks, gives actionable fix instructions ✅POST /tasks→ creates task ✅/heartbeat/agent→ returns next task ✅POST /chat/messages→ sends message ✅/capabilities→ full endpoint discovery ✅/dashboard→ serves HTML ✅What this replaces
The existing QUICKSTART.md is good but assumes OpenClaw knowledge. This guide starts from zero — someone who has Docker and wants a team of AI agents. No jargon, no assumptions.
Notes
| jqin curl examples — will clean up in a follow-up