docs: add project CLAUDE.md and nix-shell tooling memory #62

2026-07-10T11:31:50+01:00

lyrathorpe commented

2026-07-10 11:31:50 +01:00

What

Add a project-root CLAUDE.md documenting the flake's formatting and lint gates (treefmt → nixfmt/shfmt/prettier, deadnix, statix, pre-commit), how to run them (nix fmt, nix flake check, nix develop), and the host-eval step.
Add a home/claude/memory/ entry recording that any nixpkgs tool can be run ad hoc via nix run / nix shell nixpkgs#<pkg>, plus its MEMORY.md index line.

Why

The recent CI breakage was a docs edit committed without running prettier: the docs-only PR reported green (the CI detect step skips the heavy checks when no .nix/flake.lock/workflow file changes) while the push to main went red. The new CLAUDE.md records that discipline — docs are prettier-checked too — so it does not recur.

Notes

The memory addition takes effect only after a home-manager rebuild (nh home switch); ~/.claude/memory is a Nix symlink to this repo.
The project-root CLAUDE.md is read directly from the working tree — no rebuild needed.

Verification

nix flake check passes with these files (treefmt/deadnix/statix/pre-commit).

## What - Add a project-root `CLAUDE.md` documenting the flake's formatting and lint gates (treefmt → nixfmt/shfmt/prettier, deadnix, statix, pre-commit), how to run them (`nix fmt`, `nix flake check`, `nix develop`), and the host-eval step. - Add a `home/claude/memory/` entry recording that any nixpkgs tool can be run ad hoc via `nix run` / `nix shell nixpkgs#<pkg>`, plus its `MEMORY.md` index line. ## Why The recent CI breakage was a docs edit committed without running prettier: the docs-only PR reported green (the CI `detect` step skips the heavy checks when no `.nix`/`flake.lock`/workflow file changes) while the push to `main` went red. The new `CLAUDE.md` records that discipline — docs are prettier-checked too — so it does not recur. ## Notes - The memory addition takes effect only after a home-manager rebuild (`nh home switch`); `~/.claude/memory` is a Nix symlink to this repo. - The project-root `CLAUDE.md` is read directly from the working tree — no rebuild needed. ## Verification - `nix flake check` passes with these files (treefmt/deadnix/statix/pre-commit).

lyrathorpe added 2 commits 2026-07-10 11:31:50 +01:00

docs: add project CLAUDE.md documenting flake checks 33278d9ed2

Document the formatting and lint gates (treefmt/nixfmt/shfmt/prettier,
deadnix, statix, pre-commit) and how to run them, so changes -- docs
included -- are formatted before commit. Notes the CI detect step that
skips heavy checks on docs-only PRs, which can report a false green.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

chore(memory): note nix shell for ad-hoc nixpkgs tooling

CI / flake (pull_request) Successful in 13s

Details

9b7a9fa9b9

Record that any nixpkgs tool can be run on the fly via nix run / nix
shell, so a missing command during development is not a dead end. Takes
effect after a home-manager rebuild.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

lyrathorpe merged commit ad6dac634e into main

2026-07-10 11:32:25 +01:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: lyrathorpe/nixfiles#62