docs: slim README, fix drift, and remove Severance theme references#2492
Conversation
Rewrite README (238->154 lines): remove discontinued-npm badges and the dead get.automagik.dev install path, correct false claims (hybrid Postgres state instead of "all in PG", Claude/Codex only instead of "any model", smart-routed council), surface real features (Teams, persistent memory, self-healing), and point release/docs links at /releases/latest and automagik.dev/genie. Fix the upstream sources so the README cannot silently rot again: - install.ts: replace dead get.automagik.dev URL in docstring with the canonical raw.githubusercontent installer URL - CHANGELOG.md: lift the "# Changelog" H1 to the top and relocate the orphaned v4.x Host Migrations block (fixes markdownlint MD041) - move stray root artifacts report.md and audit-default-agents.md into .genie/reports/ Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Code Review
This pull request updates the documentation and comments across several files. Specifically, it reorganizes the CHANGELOG.md to place the v4.x.x host migrations section in chronological order, simplifies and updates the README.md by removing deprecated npm installation details, updating feature descriptions, and streamlining the skills table. Additionally, it updates an installation URL in a comment within src/genie-commands/install.ts. There are no review comments, so I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b313a2e863
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| | `/pm` | Full project management playbook | | ||
| | `/brain` | Knowledge graph with Obsidian-compatible vaults | | ||
| | `/pm` | Full project-management playbook | | ||
| | `/omni` | Wire a Genie agent to an Omni channel | |
There was a problem hiding this comment.
Use the canonical Omni skill invocation
When readers follow the skill table to wire Omni, /omni points at the wrong slash command: the Omni skill itself is documented as # /genie:omni in skills/omni/SKILL.md, and the agent registration help also tells users to run /genie:omni. This README entry should use the canonical /genie:omni invocation so users don't try a non-existent Genie skill command.
Useful? React with 👍 / 👎.
docs: remove Severance theme refs + fix /wizard usage (follow-up to #2492)
Summary
The README was significantly outdated and self-contradictory. This slims it (238 → 154 lines) and fixes the source-of-truth drift that was feeding it, so it can't silently rot again.
README: removed / fixed / added
Removed (wrong or dead):
get.automagik.devinstall pathbun add -g @automagik/geniemanual flowv4.260402.18Fixed (false / overstated):
/councilsoftened to "smart-routed";/reportbrowser claim softened/brainremoved from the skills table (it's agenie brainCLI command, not a skill); table now matches the real 17 skill dirs (incl./omni)docs.automagik.dev→automagik.dev/genie; release links →/releases/latestAdded (notable, real, were missing): Teams (native Claude Code teammate UI) · persistent memory (the
/brainknowledge vault) · self-healing detectors · verified supply chain (cosign + SLSA) surfaced as a one-liner.Source-of-truth fixes (so the README stays true)
src/genie-commands/install.ts— deadget.automagik.devURL in a docstring → canonicalraw.githubusercontentinstaller URLCHANGELOG.md— lifted the# ChangelogH1 to the top and relocated the orphanedv4.x — Host Migrationsblock (fixes markdownlint MD041)report.md+audit-default-agents.mdinto.genie/reports/Deliberately untouched
.genie/agents/metrics-updater/agent) — kept dev's current values.package.jsonversion — verified correct (tracks stable; dev tags run ahead by design)..genie/wishes/**+.genie/brainstorms/**get.automagik.devrefs — those are the intentional v5 distribution plan, not drift.Verification
markdownlinton README: 0 errorsbun run check:fastpassed (pre-push hook)grep get.automagik.devoutside.genie/: none🤖 Generated with Claude Code
Update — remove Severance theme references (codebase-wide)
The palette was branded after the TV show Severance (Lumon/MDR). Stripped the brand from everything shipped/user-facing while keeping the exact hex values (TUI/app/tmux render identically):
packages/genie-tokens(private pkg): renamed internal identifiers — tokenssevered→muted,outieWarm→warm,lumonBeige→beige; palette keysinnieGrey→mutedGrey,outieAmber→warmAmber— plus all doc comments. Tokens test updated (24/0 pass).src/tui/*,packages/genie-app/lib/theme.ts,scripts/tmux/*,test/visual/tui-snapshot.test.tsx,.github/workflows/ci.yml, and theCHANGELOG.mddesign-system entry.Left intact (deliberately): the
design-system-severancewish slug — DB migration050matches on that exact string to archive legacy agent rows, so renaming it would break the cleanup. Historical.genie/planning docs untouched. Thedocs/submodule (automagik-dev/docs) is a separate repo and out of scope for this PR.