Skip to content

Commit 7355b90

Browse files
committed
fix: update links
1 parent 1441518 commit 7355b90

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

template/README.md.ejs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Validates the definition.
2020

2121
## Contribution Guide
2222

23-
Below is a sample contribution guide. The tools
24-
in the repository don't restrict you to any
23+
Below is a sample contribution guide. The tools
24+
in the repository don't restrict you to any
2525
specific structure. Adjust the contribution guide
26-
to match your own structure. However, if you
26+
to match your own structure. However, if you
2727
don't have a structure in mind, this is a
2828
good place to start.
2929

@@ -32,8 +32,8 @@ adjust the file/folder organization.
3232

3333
The `.redocly.yaml` controls settings for various
3434
tools including the lint tool and the reference
35-
docs engine. Open it to find examples and
36-
[read the docs](https://docs.redoc.ly/cli/configuration/)
35+
docs engine. Open it to find examples and
36+
[read the docs](https://redoc.ly/docs/cli/configuration/)
3737
for more information.
3838

3939

template/openapi/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ That file contains references to the entire API definition.
66

77
Here are some sections to pay attention to:
88

9-
* Top-level **description**: this accepts markdown, and Redoc and Redocly API Reference will render it at the top of the docs. Consider maintaining your markdown in a separate file and [embedding it](https://docs.redoc.ly/api-reference-docs/embedded-markdown/). Note to Redoc community edition users, the special tags are only available to the Redocly API Reference users, but you can still embed markdown.
9+
* Top-level **description**: this accepts markdown, and Redoc and Redocly API Reference will render it at the top of the docs. Consider maintaining your markdown in a separate file and [embedding it](https://redoc.ly/docs/api-reference-docs/embedded-markdown/). Note to Redoc community edition users, the special tags are only available to the Redocly API Reference users, but you can still embed markdown.
1010
* Security schemes: you will define the scheme(s) your API uses for security (eg OAuth2, API Key, etc...). The security schemes are used by the Redocly API Reference "Try It" API console feature.
1111
* [Paths](paths/README.md): this defines each endpoint. A path can have one operation per http method.
1212
* Tags: it's a good idea to organize each operation. Each tag can have a description. The description is used as a section description within the reference docs.

0 commit comments

Comments
 (0)