Skip to content

docs: reorder and trim Key Features in README - #48

Merged
franzer merged 1 commit into
mainfrom
docs/readme-reorder-features
Jul 6, 2026
Merged

docs: reorder and trim Key Features in README#48
franzer merged 1 commit into
mainfrom
docs/readme-reorder-features

Conversation

@franzer

@franzer franzer commented Jul 6, 2026

Copy link
Copy Markdown
Member

Groups the README's orientation content together and slims the feature table.

Changes

  • Move Key Features up to sit directly after Use Cases, so the "what/why" material is complete before Installation and Quick Start.
  • Trim the feature table to the three headline capabilities: Blame, Git-ref Sync, Cross-tool Memory.

Why

Installation and Quick Start previously sat between Use Cases and Key Features, forcing a reader still evaluating the tool to scroll past install commands to finish understanding it. The dropped table rows (Search, Git Linking, Session Capture, MCP Server, Background Daemon) are already covered by Use Cases, Quick Start, Supported Tools, and the MCP Integration section, so no capability disappears.

Docs-only change: lightweight self-check per project rules (renders correctly, links resolve, no em dashes, factually accurate).

Move Key Features up beside Use Cases so the orientation content is
grouped ahead of installation and usage. Trim the table to the three
headline capabilities (Blame, Git-ref Sync, Cross-tool Memory); the
remaining features are already covered by their dedicated sections.
@franzer
franzer merged commit a569216 into main Jul 6, 2026
5 checks passed
@franzer
franzer deleted the docs/readme-reorder-features branch July 6, 2026 18:17
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.

1 participant