Skip to content

Commit d98fe71

Browse files
committed
docs: make section reference consistent
- Makes the style of section references consistent, - Enclose in double quotation marks (") in English - Enclose in 括弧(「」) in Japanese
1 parent 9c5b0b1 commit d98fe71

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.ja.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ const api = RestApiWithSpec.createRestApi(this, 'example-api', {
4848

4949
CDKスタックを合成すると、OpenAPI定義を含む`openapi.json`ファイルが作成されます。
5050

51-
より詳しくは[使用例](#使用例)[APIドキュメンテーション](#apiドキュメンテーション)をご参照ください。
51+
より詳しくは[使用例](#使用例)[APIドキュメンテーション](#apiドキュメンテーション)をご参照ください。
5252
実際に動くサンプルも[`example`](./example/README.ja.md)フォルダにあります。
5353

5454
## 背景

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Describe an [Amazon API Gateway (API Gateway)](https://docs.aws.amazon.com/apiga
77
## For whom is this library?
88

99
This library could help you if you would like to write a REST API and the OpenAPI definition at once using the [AWS Cloud Development Kit (CDK)](https://docs.aws.amazon.com/cdk/v2/guide/home.html) building blocks.
10-
See [_Background_](#background) for more details.
10+
See ["Background"](#background) for more details.
1111

1212
## Prerequisites
1313

@@ -48,7 +48,7 @@ const api = RestApiWithSpec.createRestApi(this, 'example-api', {
4848

4949
After synthesizing the CDK stack, you will find a file `openapi.json` containing the OpenAPI definition created.
5050

51-
Please refer to the [use cases](#use-cases) and the [API documentation](#api-documentation) for more details.
51+
Please refer to the sections ["Use cases"](#use-cases) and ["API documentation"](#api-documentation) for more details.
5252
You can also find a working example in the [`example`](./example) folder.
5353

5454
## Background

0 commit comments

Comments
 (0)