Skip to content

Commit

Permalink
docs: (even more) explicitly mention Apiary when updating API referen…
Browse files Browse the repository at this point in the history
…ce (#857)

It's already mentioned in the pre-release section just below but I
missed it anyway 🙈
  • Loading branch information
tobice authored Feb 14, 2024
1 parent 8922248 commit 62bc79d
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ The `./sources/platform/api_v2` directory contains the source file for the API r
#### Local testing

1. Install Apiary gem `gem install apiaryio`
2. After that, you can open the generated doc with the
command: `apiary preview --path="./sources/platform/api_v2/api_v2_reference.apib"`
2. After that, you can:
- Open the generated doc with the command: `apiary preview --path="./sources/platform/api_v2/api_v2_reference.apib"`
- Log into [Apiary](https://apiary.io/) to get the document analyzed for warnings (there is no automatic linter)

#### Pre-release testing

Expand Down

0 comments on commit 62bc79d

Please sign in to comment.