We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 6464441 commit 0ec7a1eCopy full SHA for 0ec7a1e
WRITING.md
@@ -188,6 +188,25 @@ Do: Check the [Solid homepage](https://www.solidjs.com)
188
Don't: Click [here](https://www.solidjs.com) to go to the Solid homepage.
189
```
190
191
+## Reference pages
192
+
193
+Reference pages document the API surface.
194
+Keep them concise and easy to scan.
195
196
+Include:
197
+- Imports
198
+- Signatures
199
+- Parameters
200
+- Return values
201
+- Short examples
202
203
+Avoid:
204
+- Narrative context or “why”
205
+- Usage guidance (“when to use”, best practices)
206
+- Long notes
207
208
+If explanation is needed, link to a guide or how-to page.
209
210
## Voice and tone
211
212
So far, we've dealt with how your contributions should look and function.
0 commit comments