You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/article-api/README.md
+3-14Lines changed: 3 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,12 +23,9 @@ The `/api/article` endpoints return information about a page by `pathname`.
23
23
24
24
### Autogenerated Content Transformers
25
25
26
-
For autogenerated pages (REST, GraphQL, webhooks, landing pages, audit logs, etc), the Article API uses specialized transformers to convert the rendered content into markdown format. These transformers are located in `src/article-api/transformers/` and use an extensible architecture:
26
+
For autogenerated pages (REST, GraphQL, webhooks, landing pages, audit logs, etc), the Article API uses specialized transformers to convert the rendered content into markdown format. These transformers are located in `src/article-api/transformers/` and use an extensible architecture.
27
27
28
-
#### Current Transformers
29
-
30
-
-**REST Transformer** (`rest-transformer.ts`) - Converts REST API operations into markdown, including endpoints, parameters, status codes, and code examples
31
-
-**GraphQL Transformer** (`graphql-transformer.ts`) - Converts GraphQL schema documentation into markdown, including queries, mutations, objects, interfaces, enums, unions, input objects, scalars, changelog, and breaking changes
28
+
#### Transformers
32
29
33
30
To add a new transformer for other autogenerated content types:
34
31
1. Create a new transformer file implementing the `PageTransformer` interface
@@ -195,15 +192,7 @@ npm run test -- src/article-api/tests
195
192
196
193
- Team: Docs Engineering
197
194
198
-
## Transformers
199
-
200
-
Currently implemented transformers:
201
-
-**REST API transformer** (`rest-transformer.ts`) - Converts REST API autogenerated content
202
-
-**GraphQL transformer** (`graphql-transformer.ts`) - Converts GraphQL API autogenerated content
0 commit comments