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

Comments are a component in docs/design/areas/comments.md, and .comment, .comment-body and .comment-form leave §5d #5536

Merged opened this

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

Merged

mason/forge:mason/5521-comments-are-a-component-in-docs-design → main 1 commit fork

  • Merged. mason/5521-comments-are-a-component-in-docs-design was merged into main as c5e8e3c.

Review

Sign in to review this change.
2 files changed +7 −3
docs/DESIGN.md −3
@@ -425,9 +425,6 @@ the same line (#4888).
425425 A `.field` directly inside a `.bar` drops its bottom margin and the bar aligns to the end, so a labelled input and its button share a baseline
426426 - **`style/components.ts`** — parts of the §5 components that the table does not spell out — the palette's list, the menu's items, a dialog's head and foot, comments, the theme picker — and a few small helpers beside them:
427427 - `.cat`
428 - `.comment`
429 - `.comment-body`
430 - `.comment-form`
431428 - `.dialog-body`
432429 - `.dialog-foot`
433430 - `.dialog-head`
docs/design/areas/comments.md added +7
@@ -0,0 +1,7 @@
1 # Comments
2
3 A comment on an issue or pull, and the form that writes one. Both are a `card()`; these classes give it its comment look.
4
5 - `.comment` — one comment as a card: its `.card-head` (byline and time) on the muted ground, the body under it. Written by `commentCard()` in `src/web/comments.ts` and by `reviewRows()` in `src/web/diff-view.ts` (an inline review comment); styled in `src/web/style/components.ts`, and spaced inside a review thread by `.dc-review .comment` in `src/web/style/content.ts`.
6 - `.comment-body` — a comment's rendered markdown, always beside `.prose`, padded inside its card. Written by `commentCard()` in `src/web/comments.ts`, `reviewRows()` in `src/web/diff-view.ts` and `reviewEntry()` in `src/web/studio/change.ts`; styled in `src/web/style/components.ts` (tighter in a timeline event's card).
7 - `.comment-form` — the card that writes a comment: a textarea and its `.form-actions`. Written by `composer()` and `editForm()` in `src/web/pages/thread.ts`, `reviewRows()` in `src/web/diff-view.ts` (a reply in a review thread) and `studioApp()` in `src/web/studio/app.ts` (the "Tell the crew" box); styled in `src/web/style/components.ts`, with its narrow-screen action line and its review-thread margin in `src/web/style/content.ts`.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs