Skip to content

Commit 97ccfda

Browse files
docs(signals): rewrite testing guide (#5107)
Closes #5106
1 parent 9d23133 commit 97ccfda

File tree

2 files changed

+353
-626
lines changed
  • .agents/skills/writing-docs
  • projects/www/src/app/pages/guide/signals/signal-store

2 files changed

+353
-626
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: writing-docs
3+
description: Doc conventions (impersonal style, formatting, Vitest in examples, structure, linking). Use when writing, editing, or reviewing guides, tutorials, or READMEs.
4+
---
5+
6+
# Writing Documentation
7+
8+
Apply when writing, editing, or reviewing docs.
9+
10+
## Voice and style
11+
12+
- **Impersonal:** No "you", "your", or second-person imperatives.
13+
- **Statements over imperatives:** Prefer "Tests should not spy" over "Avoid spying"; passive or descriptive phrasing.
14+
- **Titles:** Gerunds, not imperatives (e.g. "Testing the store" not "Test the store").
15+
- **Tone:** Direct and minimal; every sentence adds information.
16+
17+
## Formatting
18+
19+
- **Dashes:** Space-hyphen-space (`-`), not em dash (``).
20+
- **Paragraphs:** Merge single-sentence paragraphs when it helps readability.
21+
22+
## Code examples
23+
24+
- **Examples:** Simple, self-contained (e.g. Counter, Books). Short snippets; shorten or link out long async flows unless the topic is async.
25+
26+
## Structure and navigation
27+
28+
- **Section titles:** Accurate and scannable.
29+
- **Links over repetition:** Link to other guides; explain only what is specific to this page.

0 commit comments

Comments
 (0)