Skip to content

Commit 72294c6

Browse files
calliclesclaude
andauthored
Redesign README with improved structure and visual hierarchy (#12)
* Refactor README for open-source release Replace the internal product-spec README with a professional open-source README featuring centered logo, CI/coverage/license/tech badges, a clean feature overview, flow diagram, quick start guide, architecture tree, configuration reference, and contributing section. https://claude.ai/code/session_01TfegzxmcjiWN7ovfm9g1A3 * Move product spec from README to dedicated SPEC.md Extract the authoritative product requirements, page spec, scenario catalog, system behavior spec, and test coverage sections into SPEC.md. Update AGENTS.md canonical references to point to the new location. https://claude.ai/code/session_01TfegzxmcjiWN7ovfm9g1A3 --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 66ca7fa commit 72294c6

3 files changed

Lines changed: 345 additions & 217 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Repository Guidelines
22

33
## Canonical References
4-
- Product behavior and route/spec details live in `README.md` (`Page Spec`, `Scenario Catalog`, and `System Behavior Spec` sections).
5-
- Local setup, required environment variables, and command usage live in `README.md` (`Requirements (Local Dev)`, `Dev Setup`, and `Lifecycle Commands` sections).
4+
- Product behavior and route/spec details live in `SPEC.md` (`Page Spec`, `Scenario Catalog`, and `System Behavior Spec` sections).
5+
- Local setup, required environment variables, and command usage live in `README.md`.
66

77
## Project Structure & Module Organization
88
This repo is a Next.js 16 + TypeScript app-router project.

0 commit comments

Comments
 (0)