Skip to content

docs: slim README, fix drift, and remove Severance theme references#2492

Merged
namastex888 merged 1 commit into
devfrom
docs/readme-slim-and-drift-fixes
Jun 6, 2026
Merged

docs: slim README, fix drift, and remove Severance theme references#2492
namastex888 merged 1 commit into
devfrom
docs/readme-slim-and-drift-fixes

Conversation

@namastex888

@namastex888 namastex888 commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

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):

  • npm version + downloads badges (npm distribution discontinued 2026-05-09)
  • the npm "soft-deprecated / shim" callout and the dead get.automagik.dev install path
  • the broken bun add -g @automagik/genie manual flow
  • the two internal engineering sections ("Observability substrate v0" + "Executor read endpoint" SQL/ports, ~50 lines)
  • hardcoded stale release link v4.260402.18

Fixed (false / overstated):

  • "ALL state in PostgreSQL" → honest hybrid (PG for tasks/events/messages; git-versioned markdown for identity/skills/memory)
  • "any OpenAI-compatible model" → Claude or Codex (the only real adapters)
  • /council softened to "smart-routed"; /report browser claim softened
  • /brain removed from the skills table (it's a genie brain CLI command, not a skill); table now matches the real 17 skill dirs (incl. /omni)
  • docs domain docs.automagik.devautomagik.dev/genie; release links → /releases/latest

Added (notable, real, were missing): Teams (native Claude Code teammate UI) · persistent memory (the /brain knowledge 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 — dead get.automagik.dev URL in a docstring → canonical raw.githubusercontent installer URL
  • CHANGELOG.md — lifted the # Changelog H1 to the top and relocated the orphaned v4.x — Host Migrations block (fixes markdownlint MD041)
  • moved stray root artifacts report.md + audit-default-agents.md into .genie/reports/

Deliberately untouched

  • The auto-metrics block (regenerated by the .genie/agents/metrics-updater/ agent) — kept dev's current values.
  • package.json version — verified correct (tracks stable; dev tags run ahead by design).
  • .genie/wishes/** + .genie/brainstorms/** get.automagik.dev refs — those are the intentional v5 distribution plan, not drift.

Verification

  • markdownlint on README: 0 errors
  • bun run check:fast passed (pre-push hook)
  • grep get.automagik.dev outside .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 — tokens severed→muted, outieWarm→warm, lumonBeige→beige; palette keys innieGrey→mutedGrey, outieAmber→warmAmber — plus all doc comments. Tokens test updated (24/0 pass).
  • Scrubbed comments/descriptions in src/tui/*, packages/genie-app/lib/theme.ts, scripts/tmux/*, test/visual/tui-snapshot.test.tsx, .github/workflows/ci.yml, and the CHANGELOG.md design-system entry.
  • README Design section: dropped "inspired by Severance".

Left intact (deliberately): the design-system-severance wish slug — DB migration 050 matches on that exact string to archive legacy agent rows, so renaming it would break the cleanup. Historical .genie/ planning docs untouched. The docs/ submodule (automagik-dev/docs) is a separate repo and out of scope for this PR.

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>
@coderabbitai

coderabbitai Bot commented Jun 6, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 1f599c42-b5ab-4b96-b335-78fe0e481b52

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-slim-and-drift-fixes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread README.md
| `/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 |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@namastex888 namastex888 merged commit eac7710 into dev Jun 6, 2026
16 checks passed
@namastex888 namastex888 changed the title docs: slim README and fix the drift feeding it docs: slim README, fix drift, and remove Severance theme references Jun 6, 2026
namastex888 added a commit that referenced this pull request Jun 6, 2026
docs: remove Severance theme refs + fix /wizard usage (follow-up to #2492)
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