Skip to content

docs(repo): trim the readme and rename CLAUDE.md to AGENTS.md - #109

Merged
mrcsin merged 1 commit into
masterfrom
readme-trim
Oct 5, 2026
Merged

mrcsin merged 1 commit into
masterfrom
readme-trim

Conversation

@mrcsin

@mrcsin mrcsin commented Oct 5, 2026

Copy link
Copy Markdown
Member

Problem

The readme had grown to 168 lines of behaviour rules, bench internals and test-harness detail that docs/architecture already holds, and the agent instructions lived in CLAUDE.md rather than the default AGENTS.md.

What changed

  • readme.md: a short description, four screenshots in docs/img/, the features in three groups, a three-row requirements table and the one command that starts the viewer.
  • CLAUDE.md is renamed AGENTS.md. The live docs (docs/architecture/*, docs/plans/backlog.md) and one test comment point at the new name; completed plans keep the old one. The dev-config copy recipe is the one in AGENTS.md.

Verification

  • git grep -n "CLAUDE\.md" -- . ':!docs/plans/completed' ':!docs/plans/roadmaps' prints nothing.
  • The renamed references keep their line length, so no doc wrap moved.
Per-task commits before collapse
627bf64 docs(repo): apply the readme edits
d29d531 docs(repo): trim the readme to its essentials
bd02e55 docs(repo): rename CLAUDE.md to AGENTS.md

https://claude.ai/code/session_01PfZJa7neMMKPzycFR6iuhD

The readme had grown to 168 lines of behaviour rules, bench internals
and test-harness detail that docs/architecture already holds. It now
follows the sibling repositories: a short description, four
screenshots, the features in three groups of short points, a
three-row requirements table and the one command that starts the
viewer.

CLAUDE.md becomes AGENTS.md, the file name agents read by default. The
live docs, the backlog and one test comment point at the new name;
completed plans keep the old one as the record of their time. The copy
recipe for SemiPlot/Artifacts/dev-config is the one in AGENTS.md.

Claude-Session: https://claude.ai/code/session_01PfZJa7neMMKPzycFR6iuhD
@mrcsin
mrcsin merged commit b377013 into master Oct 5, 2026
2 checks passed
@mrcsin
mrcsin deleted the readme-trim branch October 5, 2026 15:15
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