Skip to content

docs(readme): fix malformed usage sections for recent features#140

Merged
jsburckhardt merged 1 commit into
mainfrom
fix/readme-usage-sections
Jun 25, 2026
Merged

docs(readme): fix malformed usage sections for recent features#140
jsburckhardt merged 1 commit into
mainfrom
fix/readme-usage-sections

Conversation

@jsburckhardt

Copy link
Copy Markdown
Owner

Many of the per-feature usage sections in the README had degraded over the recent rounds of feature PRs being merged in parallel:

  • Collapsed sections (heading + one-line description only, no usage blocks): fzf, lazygit, ripgrep, fd, rtk, zoxide, hyperfine, glow, fx, hurl, markitdown, ast-grep, zizmor.
  • Intermingled blocks: e.g. the delta section contained a jsonc block listing fzf/lazygit/ripgrep/fd/rtk/zoxide/hyperfine/glow/fx/hurl/jj/delta together; the open-code-review section had a combined jsonc + bash for markitdown/ast-grep/zizmor/open-code-review; actionlint ended with skillspector --version; mise and difftastic shared one jsonc block; jj's bash block included difft --version.

This PR rewrites the trailing portion of the README so that each feature from fzf onward gets the same clean four-element structure used by the older sections:

  1. ### \`` heading
  2. one-line description
  3. jsonc devcontainer config snippet
  4. bash version-check command

Affects 20 features. No other content is touched.

Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

Rewrites usage sections from fzf onward so each feature gets a clean,
consistent heading + jsonc + bash block. Previously several sections
were collapsed to a single line and the jsonc/bash blocks for delta,
mise, jj, difftastic, open-code-review, skillspector and actionlint
were intermingled across feature headings.

Affected features: fzf, lazygit, ripgrep, fd, rtk, zoxide, hyperfine,
glow, fx, hurl, markitdown, ast-grep, mise, jj, difftastic, delta,
actionlint, zizmor, open-code-review, skillspector.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jsburckhardt jsburckhardt merged commit 35d8753 into main Jun 25, 2026
233 of 236 checks passed
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