Skip to content

docs: update contribution guideline #3057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions website/docs/contributing/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,25 @@ To make using the specs in these contexts easier, follow these guidelines:
- Use inline Markdown links judiciously.
Don't link to readily searchable information, such as internet RFCs or Uncyclopedia.

### Markdown in long descriptions

Operations and parameters may need more information that can fit in one sentence.
In that case, split your descriptions into two or more paragraphs:

```yaml
description: |
First sentence as short description (no markdown, just plain text).

More information in separate paragraphs after an empty line.
You can use **Markdown** here.
```

Use the `|` character to write multi-line descriptions.

The first sentence can be used as a _short description_ in environments that don't support Markdown,
such as the [Algolia CLI](https://github.com/algolia/cli/).
After an empty line, you can provide more context.

## Capitalization

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

Use the `|` character for multiline descriptions:

```yaml
description: |
A multiline description.

Multi-paragraph even.
```

## Properties and parameter descriptions

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