docs: code example

Co-authored-by: nulltoken <emeric.fermas@gmail.com>
stoplightio · Jun 23, 2020 · b166c92 · b166c92
1 parent 194e48f
commit b166c92
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/getting-started/rulesets.md b/docs/getting-started/rulesets.md
@@ -134,4 +134,11 @@ 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.