Skip to content

Commit c728720

Browse files
authored
Refine transformers section in README.md (#59174)
1 parent 3674ab8 commit c728720

File tree

1 file changed

+3
-14
lines changed

1 file changed

+3
-14
lines changed

src/article-api/README.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,9 @@ The `/api/article` endpoints return information about a page by `pathname`.
2323

2424
### Autogenerated Content Transformers
2525

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.
2727

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
3229

3330
To add a new transformer for other autogenerated content types:
3431
1. Create a new transformer file implementing the `PageTransformer` interface
@@ -195,15 +192,7 @@ npm run test -- src/article-api/tests
195192

196193
- Team: Docs Engineering
197194

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
203-
- **Audit logs transformer** (`audit-logs-transformer.ts`) - Converts audit log tables to markdown
204-
205195
### Known limitations
206-
- Some autogenerated content types don't have transformers yet
207196
- Cache invalidation is manual
208-
- No built-in rate limiting
197+
- No built-in rate limiting (uses Fastly instead)
209198
- Limited API versioning

0 commit comments

Comments
 (0)