Skip to content

docs: README alignment — ToC, all 6 plugins, consistent install blocks#63

Merged
bearmug merged 5 commits into
mainfrom
readme-alignment
Feb 28, 2026
Merged

docs: README alignment — ToC, all 6 plugins, consistent install blocks#63
bearmug merged 5 commits into
mainfrom
readme-alignment

Conversation

@bearmug
Copy link
Copy Markdown
Contributor

@bearmug bearmug commented Feb 28, 2026

Summary

  • Root README rewritten: table of contents with all 6 plugins, each with tagline + short description + self-contained install block + link to full docs; demo.gif removed; local-brain and mdbrowser sections added (were missing)
  • Plugin READMEs normalized: vibes, remote-layout, and local-brain install blocks now include /plugin marketplace add step; each block ends with the correct first-run command (/hub-setup, /market-regime, /brain-setup, /browse https://example.com, /remote-layout watch) or none where hooks auto-activate
  • claude-status-hub README: animated GIF reference removed; vibes README gets matching badges

First-run commands applied

Plugin First-run command
Status Hub /hub-setup
TradingView /market-regime
local-brain /brain-setup
mdbrowser /browse https://example.com
Vibes (none — hooks auto-activate)
Remote Layout /remote-layout watch

Test Plan

  • Root README renders correctly on GitHub — ToC links resolve, all 6 plugin sections visible
  • No .gif image references anywhere in root README or claude-status-hub README
  • Every install block starts with /plugin marketplace add fiale-plus/fiale-claude-plugins
  • vibes README has Claude Code Plugin + License badges
  • All 180 plugin tests pass (plugins/claude-status-hub/tests/run-tests.sh)

🤖 Generated with Claude Code

@bearmug
Copy link
Copy Markdown
Contributor Author

bearmug commented Feb 28, 2026

Code review

Found 1 issue:

  1. Root README Remote Layout section states "Three modes" and omits the off mode from the table, but off is a valid, implemented mode — the plugin's own README and the command definition (argument-hint: code|code-wrap|watch|off) both include it. The prose and table should be updated to reflect four modes.

Switch Claude's response format for small screens. Three modes: `code` (hard 28-char lines), `code-wrap` (zoom-mode autowrap), `watch` (ultra-terse with one-tap numbered replies). Persists across sessions.
| Mode | Description |
|------|-------------|
| `code` | Fenced code block, 28-char lines — tight monospace |
| `code-wrap` | Fenced code block, no line limit — zoom-mode autowrap |
| `watch` | Ultra-terse, always ends with 3 numbered REPLY options |

🤖 Generated with Claude Code

- If this code review was useful, please react with 👍. Otherwise, react with 👎.

@bearmug bearmug merged commit ced5e7a into main Feb 28, 2026
1 check passed
@bearmug bearmug deleted the readme-alignment branch February 28, 2026 22:30
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