Skip to content

Overhaul README for clarity #159

Merged
user1303836 merged 1 commit intomainfrom
readme-overhaul
Mar 11, 2026
Merged

Overhaul README for clarity #159
user1303836 merged 1 commit intomainfrom
readme-overhaul

Conversation

@user1303836
Copy link
Owner

@user1303836 user1303836 commented Mar 11, 2026 •
edited
Loading

Summary

  • Replace the internal-facing "What Exists Today" section with a user-oriented Features description
  • Move Quick Start to the top with a compact, copy-paste-ready flow (clone → docker → init → ingest → API)
  • Add a Datasets table showing the Bronze → Silver → Gold pipeline
  • Restructure API section with runnable curl examples and a collapsible full endpoint reference
  • CLI section uses a clean table instead of a bullet list
  • Cut overall length from ~370 lines to ~155 lines

Test plan

  • Verify all curl examples match current API routes
  • Confirm Quick Start steps work on a fresh clone
  • Review rendering on GitHub

@user1303836 user1303836 changed the title Overhaul README for clarity and new-user appeal Overhaul README for clarity Mar 11, 2026
@user1303836 @claude
docs: overhaul README for clarity and new-user appeal
3b14f58 
Restructure the README around a fast Quick Start flow,
replace the internal-facing "What Exists Today" section
with user-oriented Features, Datasets, and API sections,
and trim overall length from 370 to 155 lines.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@user1303836 user1303836 merged commit eeb8dd1 into main Mar 11, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@user1303836