Skip to content

docu(read-me): docs: hoist Prerequisites and Quickstart above the 2-m… - #597

Open
sneumannb5 wants to merge 1 commit into
byte5ai:mainfrom
sneumannb5:docu/400-readme-order
Open

docu(read-me): docs: hoist Prerequisites and Quickstart above the 2-m…#597
sneumannb5 wants to merge 1 commit into
byte5ai:mainfrom
sneumannb5:docu/400-readme-order

Conversation

@sneumannb5

@sneumannb5 sneumannb5 commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

What

Reorder README top: hoist Prerequisites and ⚡ Quickstart above 🎬 The 2-minute pitch, so a dev arriving for setup reaches the install command before the video. Pure reordering, no copy rewrite. Closes #400.

Why

Marketing site is now business-led; developers land here via "View on GitHub", making this README the dev-first entry point. A dev who came for setup should hit docker compose up -d fast, not scroll past a video first. Video keeps its place in the narrative, now right after the command ("read it, then watch it run").

Test plan

  • git diff shows only moved lines (+ heading level ######), zero wording edits
  • Video embed URL byte-identical to previous (644f9dae-…)
  • Rendered order: header → intro → Prerequisites → ⚡ Quickstart → 🎬 pitch → 🚀 First run
  • Anchors still resolve: #-quickstart, #why-omadia, #status--roadmap, #optional-features

Risk / blast radius

Docs-only, single file. No code, schema, API, CI, or env-var impact. Heading promoted ###### for consistency with sibling sections (either level defensible per triage); no anchor referenced the pitch, so nav/badge links unaffected.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

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.

README: move Quickstart above the pitch video (dev-first hand-off from the site)

1 participant