Skip to content

Tighten README intro and remove duplicated sections#6

Merged
varjoranta merged 1 commit into
mainfrom
docs/readme-tighten
May 15, 2026
Merged

Tighten README intro and remove duplicated sections#6
varjoranta merged 1 commit into
mainfrom
docs/readme-tighten

Conversation

@varjoranta
Copy link
Copy Markdown
Owner

Summary

Restructures the README's framing so the pitch and shape land before the long example, and removes redundancy that the new sections introduced.

  • New tagline + bullets + "First look" code block so a reader sees real syntax in 30 seconds.
  • New "What etchdb is / is not" pair near the top -- user-friendly framing of the surface area.
  • New stand-alone "Why etchdb?" section that also absorbs the AI-assisted-development paragraph from the old lower "Why".
  • Drops the duplicated lower "Why", "Goals", and "Non-goals" sections -- their content is now covered by the top-of-file framing.
  • Drops the explicit version from Status (was stale at v0.6.0; staying evergreen avoids chasing every patch release).

No code changes; README only.

Test plan

  • Render check on the PR's Files Changed tab -- headings, code blocks, lists.

- Add tagline + bullets + "First look" code block up front so the
  pitch lands before the deep example.
- Add "What etchdb is / is not" near the top as the user-facing
  framing.
- Add a stand-alone "Why etchdb?" section that absorbs the
  AI-assisted-development paragraph from the lower "Why" section.
- Drop the lower "Why", "Goals", and "Non-goals" sections -- their
  content was duplicating the top-of-file framing.
- Drop the explicit version from Status (was stale at "v0.6.0";
  staying evergreen is simpler than chasing every patch release).
@varjoranta varjoranta merged commit 2c193f1 into main May 15, 2026
7 checks passed
@varjoranta varjoranta deleted the docs/readme-tighten branch May 15, 2026 10:37
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.

1 participant