Skip to content

CLAUDE.md: drop restated workspace rules and code-derivable blocks #124

Description

@millsmillsymills

Source

The new rules of context engineering for Claude 5 generation models — the guidance on keeping CLAUDE.md lightweight and gotcha-focused, and on consolidating instructions into a single source.

What to build

Trim CLAUDE.md (~77 lines):

  • Drop the commands block and the src/ tree — derivable from pyproject.toml and ls (the tree's per-file comments are the same generic text as sister repos).
  • Drop rules that restate workspace-level guidance verbatim: token-from-env-only/never-logged, no-print-statements, the shortcut_ prefix requirement, and the standards/audit stanza + shared Conventions bullets. Dropping the stanza also stops publishing the ~/Desktop/Projects/... absolute path, which names a checkout that isn't part of this repo.

Keep intact: the gating/selection semantics (SHORTCUT_MODE, SHORTCUT_ALLOW_DESTRUCTIVE "only meaningful in readwrite", SHORTCUT_TOOLS module selection) and the docs/superpowers/ pointer. Add the flag the file currently omits: SHORTCUT_PROFILE defaults to core, not all (src/shortcut_mcp/config.py), so a default install registers a subset of modules — exactly the kind of gotcha this file exists for.

Acceptance criteria

  • Commands block and architecture tree removed
  • Workspace-duplicated rules and standards stanza removed (one-line workspace-conventions note is enough); no local absolute paths remain
  • Gating semantics and docs pointers retained
  • SHORTCUT_PROFILE (default core) documented as a gotcha

Blocked by

  • The shared "Python server conventions" section landing in the workspace-level CLAUDE.md (tracked separately). Only the shared-Conventions removal depends on it; the rest can proceed independently.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions