Public: anyone can read this; the crew can change it.

The plan map is a component in docs/design/areas/map.md, and its classes leave §5d #5509

Merged opened this

Check · Review · Land · Live done — Landed and live in production.

Merged

The map of what waits for what (`/:owner/:name/map`) is now documented as one component in a new area file, `docs/design/areas/map.md`. Its nineteen `.map-*` classes are gone from `docs/DESIGN.md` §5d. Only documentation changed: no markup or stylesheet rule was touched, so the map page looks the same as before.

shipped production is serving it deploy da65c36

opened this

The map of what waits for what (/:owner/:name/map) is now documented as one component in a new area file, docs/design/areas/map.md. Its nineteen .map-* classes are gone from docs/DESIGN.md §5d. Only documentation changed: no markup or stylesheet rule was touched, so the map page looks the same as before.

  • docs/design/areas/map.md (new) follows the shape of the other area files. It says what the map is, that mapPage in src/web/pages/map.ts draws the page, drawMap draws the SVG, and mapCss holds the rules. Each class gets a one-line bullet in a code span saying what it is for. It also notes that a card's state is set by data-state on .map-node, not by a class.
  • docs/DESIGN.md: the nineteen class lines are deleted from §5d. I also deleted the pages/map.ts heading above them, which the issue didn't list. With its classes gone it would have been an empty heading. The design check only reads class names in code spans, so removing it changes nothing it checks.

To try it: bun scripts/design-lint.ts passes, and so does bun test test/design-lint.test.ts, which includes the check that every defined class is documented (16 pass, 0 fail).

🤖 Generated with Claude Code

Closes #5495

commented

The map of what waits for what (/:owner/:name/map) is now documented as one component in a new area file, docs/design/areas/map.md. Its nineteen .map-* classes are gone from docs/DESIGN.md §5d. Only documentation changed: no markup or stylesheet rule was touched, so the map page looks the same as before.

  • docs/design/areas/map.md (new) follows the shape of the other area files. It says what the map is, that mapPage in src/web/pages/map.ts draws the page, drawMap draws the SVG, and mapCss holds the rules. Each class gets a one-line bullet in a code span saying what it is for. It also notes that a card's state is set by data-state on .map-node, not by a class.
  • docs/DESIGN.md: the nineteen class lines are deleted from §5d. I also deleted the pages/map.ts heading above them, which the issue didn't list. With its classes gone it would have been an empty heading. The design check only reads class names in code spans, so removing it changes nothing it checks.

To try it: bun scripts/design-lint.ts passes, and so does bun test test/design-lint.test.ts, which includes the check that every defined class is documented (16 pass, 0 fail).

🤖 Generated with Claude Code

Approved

Docs-only move. All 19 .map-* classes in src/web/pages/map.ts are documented in the new docs/design/areas/map.md, the state-by-data-state note and the is-view/is-drag/is-cut modifiers match the source, and the 272px / 860px figures match the CSS. design-lint passes. No markup or behaviour changes, so there is no page, terminal or security surface to regress. Two things next: (1) add the area file to the docs/design/areas/README.md index if it lists areas; (2) pin the 272px/860px numbers less literally, or they will drift when mapCss changes.

Sign in to join this conversation.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs