Skip to content

Lead README with screenshot, pitch, and embedding story#82

Merged
zeevdr merged 1 commit into
mainfrom
docs/readme-pitch
Jun 10, 2026
Merged

Lead README with screenshot, pitch, and embedding story#82
zeevdr merged 1 commit into
mainfrom
docs/readme-pitch

Conversation

@zeevdr

@zeevdr zeevdr commented Jun 10, 2026

Copy link
Copy Markdown
Member

Summary

  • The README was a developer setup doc with no screenshot — for a graphical product, the most demo-able thing we have was invisible.
  • The embed/white-label story (layout modes, feature toggles, labels.json) was buried as env-var documentation instead of leading with who it's for.
  • Add a config-editor screenshot and a one-to-two line "what it's for" pitch above Development, and promote layout modes + feature toggles into a new "Embedding and white-labeling" section linking to docs/ui-modes.md.

Test plan

  • Rendered README locally to confirm the screenshot displays and links resolve

Closes #81

The README was a setup doc with no image, and the embed/white-label
story was buried as env-var documentation. Add a config-editor
screenshot and a one-line pitch up top, and promote layout modes,
feature toggles, and labels.json into a dedicated "Embedding and
white-labeling" section.

Closes #81

Co-Authored-By: Claude <noreply@anthropic.com>
@zeevdr zeevdr added this to the Beta Readiness milestone Jun 10, 2026
@zeevdr zeevdr added size: M Moderate — a day or two, clear scope priority: P0 Blocks alpha or release labels Jun 10, 2026
@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@zeevdr zeevdr merged commit 7040b93 into main Jun 10, 2026
9 checks passed
@zeevdr zeevdr deleted the docs/readme-pitch branch June 10, 2026 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority: P0 Blocks alpha or release size: M Moderate — a day or two, clear scope

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sell the admin GUI in its README (screenshot, purpose, modes)

1 participant