Skip to content

docs: make README fool-proof for operators (COW-984)#73

Merged
lgahdl merged 1 commit into
developfrom
luizhatem/cow-984-docs-make-readme-fool-proof-for-operators-with-no-ponder
May 29, 2026
Merged

docs: make README fool-proof for operators (COW-984)#73
lgahdl merged 1 commit into
developfrom
luizhatem/cow-984-docs-make-readme-fool-proof-for-operators-with-no-ponder

Conversation

@lgahdl
Copy link
Copy Markdown
Contributor

@lgahdl lgahdl commented May 28, 2026

Summary

  • Add "Is it working?" section to README with a quick-reference table of health endpoints
  • Explain the two indexing phases (backfill vs. live) and how long backfill takes
  • Distinguish "slow but working" from "actually stuck" with concrete checks
  • Add note that first run takes time and the API is queryable throughout

Addresses client feedback: "The README should be fool-proof — someone with no knowledge of Ponder should understand how to run it and tell if it's broken."

Related Issues

COW-984

🤖 Generated with Claude Code

Add "Is it working?" section explaining what to check during and after
backfill, how to distinguish stuck from slow, and what each health
endpoint signals. Addresses client feedback that the README should be
fool-proof for operators with no Ponder background.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@linear-code
Copy link
Copy Markdown

linear-code Bot commented May 28, 2026

COW-984

@lgahdl lgahdl merged commit 42dac5f into develop May 29, 2026
4 checks passed
@lgahdl lgahdl deleted the luizhatem/cow-984-docs-make-readme-fool-proof-for-operators-with-no-ponder branch May 29, 2026 19:17
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