From 297cc9f75bc0ff0e21f1c4f8085c49b650bf3cf9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Ro=C5=BCek?= Date: Tue, 23 Jun 2020 14:49:18 +0200 Subject: [PATCH] docs: code example Co-authored-by: nulltoken --- docs/getting-started/rulesets.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/getting-started/rulesets.md b/docs/getting-started/rulesets.md index fdbe2eef3d..b045d85039 100644 --- a/docs/getting-started/rulesets.md +++ b/docs/getting-started/rulesets.md @@ -134,4 +134,9 @@ Whatever you link you provide, the rule name will be appended as an anchor. Given the following `documentationUrl` [`https://stoplight.io/p/docs/gh/stoplightio/spectral/docs/reference/openapi-rules.md`](https://stoplight.io/p/docs/gh/stoplightio/spectral/docs/reference/openapi-rules.md), an example URL for `info-contact` rule would look as follows [`https://stoplight.io/p/docs/gh/stoplightio/spectral/docs/reference/openapi-rules.md#info-contact`](https://stoplight.io/p/docs/gh/stoplightio/spectral/docs/reference/openapi-rules.md#info-contact). +```yaml +documentationUrl: https://www.example.com/docs/api-ruleset.md + +rules: + # ... If no `documentationUrl` is provided, no links will show up, and users will just have to rely on the error messages to figure out how the errors can be fixed.