Skip to content

Restyle README in centered feature-wall format#1340

Open
r3dbars wants to merge 1 commit into
mainfrom
claude/readme-format-orca-ukx94z
Open

Restyle README in centered feature-wall format#1340
r3dbars wants to merge 1 commit into
mainfrom
claude/readme-format-orca-ukx94z

Conversation

@r3dbars

@r3dbars r3dbars commented Jun 29, 2026

Copy link
Copy Markdown
Owner

Why

The README read as a long single-column wall. This restyles it into a centered, scannable layout (inspired by the format of stablyai/orca) so the product lands faster for someone skimming on GitHub. Same content and claims — new layout.

Product Impact

  • Affects: docs only
  • Lane: activation
  • Why this matters: the README is the top-of-funnel for the repo; a cleaner, more visual layout helps it convert browsers into downloads.

What changed

  • Centered hero header: logo + name (<h1 align="center">), centered badge row, tagline, and a Download for macOS CTA.
  • --- horizontal-rule breaks between major sections.
  • Two-column Features wall: text left, screenshot/GIF right, with Docs → links (Record any meeting, Dictation, Connect your AI, Name a speaker once).
  • #### Also in the box condensed bullet list for secondary features.
  • Works with any agent row using <kbd> badges (Claude Code, Claude Desktop, Codex, Cursor, Obsidian, + any folder-reading tool).
  • Install section grouped under ### Requirements / ### Desktop subheadings.
  • Kept the existing file-sample, FAQ, Privacy, Developing, and License content intact.
  • Added docs/assets/transcripted-icon.png (copied from scripts/release/assets/app-icon-base.png) for the centered header logo.

How I checked it

  • scripts/dev/agent-preflight.sh
  • Selected checks from .agents/test-matrix.yml for the files changed (docs-only → preflight)
  • bash build.sh --no-open — not applicable, docs-only
  • bash run-tests.sh — not applicable, docs-only
  • Manual check: reviewed every image/anchor link path against the tree; all referenced assets exist.

Risk Review

  • Privacy / local-first behavior reviewed — copy unchanged in substance
  • Storage path or migration impact reviewed — none
  • Public-facing copy stays concrete and matches current product scope
  • Release/update impact reviewed — none
  • Agent PRs link the issue/workpad and stay draft until human review
  • UI changes include sanitized .agent-review/visuals/ evidence — N/A, README reuses existing launch assets
  • No private transcripts, audio, tokens, personal paths, or customer data are included

Notes

Layout format adapted from stablyai/orca's README. All wording is Transcripted's own; only the structure was borrowed.

Agent handoff

COORD_DONE: GREEN | (this PR) | restyled README into centered feature-wall layout + added header icon asset | none | none | scripts/dev/agent-preflight.sh | review rendered README on GitHub and merge if the look is right

🤖 Generated with Claude Code

https://claude.ai/code/session_01M99oPWn1ARshQ4sHBuCoyr


Generated by Claude Code

Reformat the README to a centered hero header (logo, badge row, tagline,
download CTA), horizontal-rule section breaks, a two-column feature wall
with media, a <kbd> agent-compatibility row, and platform-grouped Install
section. Same product content, new layout. Adds docs/assets/transcripted-icon.png
for the centered header.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01M99oPWn1ARshQ4sHBuCoyr
@r3dbars

r3dbars commented Jul 2, 2026

Copy link
Copy Markdown
Owner Author

Held in the July 2 cleanup pass. This is a broad README redesign and became DIRTY after #1339 landed the small sponsor-link README change. Needs a refresh against current main plus a content/design review before merge; not closing because it is not obviously superseded by #1339.

@r3dbars r3dbars marked this pull request as ready for review July 3, 2026 01:34
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.

2 participants