Skip to content

Ship the runnable demos the front door promises #44

@zeevdr

Description

@zeevdr

Description

Our public entry points promise runnable demos, but the demos repo ships none — the single biggest credibility gap before beta. The org profile README advertises "try OpenDecree in 5 minutes" and decree/README.md says "Each demo runs with a single docker compose up", yet demos/README.md (line 33) reads "Coming soon — demos are being built." A visitor who follows our primary call-to-action hits vapor: the "Pick Your Path" table lists six demos, none runnable.

Why this blocks beta

The demos repo is the conversion surface we point new users to first. Shipping beta with an empty front-door demo actively burns the trust the rest of the docs work to build.

Scope

Ship the two demos already scaffolded as directories:

  • quickstart/ — create a schema, set config values, watch them update live (promised by both the org profile and the core README)
  • rest-walkthrough/ — drive the REST API with curl only, zero install

Each must satisfy the repo's own "what each demo includes" contract (README, self-contained docker-compose, devcontainer, test.sh, cleanup).

Acceptance criteria

  • docker compose up in quickstart/ works from a clean checkout (server + Postgres + Redis)
  • docker compose up in rest-walkthrough/ works from a clean checkout
  • Each demo has a README, test.sh, devcontainer, and cleanup instructions
  • CI runs each test.sh and it passes
  • The "Coming soon" banner (line 33) is removed
  • The "Pick Your Path" table links only to demos that exist; unshipped rows are clearly marked as planned, not linked as if live
  • Both Codespaces badges at the top boot a working environment

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentationpriority: P0Blocks alpha or releasesize: LLarger effort — multiple days, design decisions needed

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions