Skip to content

Commit c23a6d3

Browse files
committed
Addresses feedback.
1 parent c1526cc commit c23a6d3

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ The repository has the following structure:
1818
This JSON representation is formally defined by [a set of TypeScript definitions (a meta-model)](./compiler/src/model/metamodel.ts)
1919
that also explains the various properties and their values.
2020

21+
> [!TIP]
22+
> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to our [contribution guide](https://www.elastic.co/docs/extend/contribute/api-docs/).
2123
2224
## Prepare the environment
2325

docs/add-new-api.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@ in this repository, or we do have an endpoint definition in [`/specification/_js
55
but we don't have a type definition for it.
66
In this document you will see how to add a new endpoint and how to add a new endpoint definition.
77

8-
Refer to the
9-
[API docs contribution guidelines](https://www.elastic.co/docs/extend/contribute/api-docs/)
10-
to learn more about how to craft great docs for your API.
8+
> [!TIP]
9+
> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to our [contribution guide](https://www.elastic.co/docs/extend/contribute/api-docs/).
1110
1211
## How to add a new endpoint
1312

docs/modeling-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ the basic types [here](https://www.typescriptlang.org/docs/handbook/basic-types.
99
while in [behaviors](./behaviors.md) you can find the list of special interfaces used
1010
for describing APIs that can't be represented in the specification.
1111

12-
Refer to the [API docs contribution guidelines](https://www.elastic.co/docs/extend/contribute/api-docs/) to add documentation to types and fields.
12+
Refer to the [documentation guide](doc-comments-guide.md) to add documentation to types and fields.
1313

1414
### Dictionary
1515

docs/schema-structure.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,12 @@ the basic types [here](https://www.typescriptlang.org/docs/handbook/basic-types.
99
while in [behaviors](./behaviors.md) you can find the list of special interfaces used
1010
for describing APIs that can't be represented in the specification.
1111

12-
Refer to the [API docs contributon guidelines](https://www.elastic.co/docs/extend/contribute/api-docs/) to add documentation to types and fields,
12+
Refer to the [documentation guide](doc-comments-guide.md) to add documentation to types and fields,
1313
and to the [modeling guide](modeling-guide.md) to learn how to model the different types.
1414

15+
> [!TIP]
16+
> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to our [contribution guide](https://www.elastic.co/docs/extend/contribute/api-docs/).
17+
1518
You can find the schema representing all APIs and types in the [output folder](output/schema/schema.json).
1619
The schema is structured as follows:
1720

0 commit comments

Comments
 (0)