Skip to content

Commit 5c473cc

Browse files
authored
docs: update contribution guideline (#3057)
1 parent 2bfa3a0 commit 5c473cc

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

website/docs/contributing/docs.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,25 @@ To make using the specs in these contexts easier, follow these guidelines:
3030
- Use inline Markdown links judiciously.
3131
Don't link to readily searchable information, such as internet RFCs or Uncyclopedia.
3232

33+
### Markdown in long descriptions
34+
35+
Operations and parameters may need more information that can fit in one sentence.
36+
In that case, split your descriptions into two or more paragraphs:
37+
38+
```yaml
39+
description: |
40+
First sentence as short description (no markdown, just plain text).
41+
42+
More information in separate paragraphs after an empty line.
43+
You can use **Markdown** here.
44+
```
45+
46+
Use the `|` character to write multi-line descriptions.
47+
48+
The first sentence can be used as a _short description_ in environments that don't support Markdown,
49+
such as the [Algolia CLI](https://github.com/algolia/cli/).
50+
After an empty line, you can provide more context.
51+
3352
## Capitalization
3453

3554
In general, follow the capitalization of the API.
@@ -170,15 +189,6 @@ but you can expand it.
170189
Add paragraphs with more information that users might need when using this endpoint,
171190
such as limitations, side effects, or any other information that can't be expressed in the schema.
172191

173-
Use the `|` character for multiline descriptions:
174-
175-
```yaml
176-
description: |
177-
A multiline description.
178-
179-
Multi-paragraph even.
180-
```
181-
182192
## Properties and parameter descriptions
183193

184194
Use a noun phrase to describe what the parameter represents, without articles.

0 commit comments

Comments
 (0)