Skip to content

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

Description

@iret77

Context

The marketing site (byte5ai/omadia-homepage) hero is now business-led: the primary CTA is the pilot, and developers are routed to this repo through a "View on GitHub" secondary CTA. That makes this README the dev-first entry point. For the hand-off to land, a developer who arrives looking for setup should reach the install command fast.

Problem

The top of the README currently reads:

  1. one-line intro
  2. 🎬 The 2-minute pitch (video)
  3. Prerequisites
  4. ⚡ Quickstart (docker compose up -d)

A developer who came for setup instructions has to scroll past a video to get to the command. Developers looking for setup instructions do not want to watch a video first.

Change (pure reordering, no copy rewrite)

Hoist Prerequisites and ⚡ Quickstart above 🎬 The 2-minute pitch. Keep the bold one-line intro at the very top (it is the identity statement). Suggested order:

  1. Header (wordmark, tagline, badges, nav links) — unchanged
  2. One-line intro paragraph — unchanged
  3. Prerequisites
  4. ⚡ Quickstart (git clone … && docker compose up -d)
  5. 🎬 The 2-minute pitch (now right after the command: read it, then watch it run)
  6. 🚀 First run → Why omadia → …

The video keeps its place in the narrative, just after the command rather than before it.

Out of scope

No changes to the section contents themselves. Keep the current voice (the README is free of em-dashes and negation-reveal hooks; keep it that way).

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions