Skip to content

Commit 164c786

Browse files
authored
add descriptions for readme config fields in generators.yml reference (#204)
1 parent 817c222 commit 164c786

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

fern/products/sdks/reference/generators-yml-reference.mdx

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ metadata:
378378
</ParamField>
379379

380380
## readme
381-
Controls what goes into the generated README files across all SDKs.
381+
Controls what goes into the generated README files across all SDKs, allowing you to customize the content and structure of your SDK documentation.
382382

383383
```yaml
384384
readme:
@@ -401,31 +401,39 @@ readme:
401401
path: "/users"
402402
```
403403

404-
<ParamField path="readme" type="ReadmeSchema" required={false} toc={true}>
404+
<ParamField path="bannerLink" type="string" required={false} toc={true}>
405+
URL for a banner image or link that appears at the top of the README.
405406
</ParamField>
406407

407-
<ParamField path="readme.bannerLink" type="string" required={false} toc={true}>
408+
<ParamField path="introduction" type="string" required={false} toc={true}>
409+
Custom introduction text that appears at the beginning of the README.
408410
</ParamField>
409411

410-
<ParamField path="readme.introduction" type="string" required={false} toc={true}>
412+
<ParamField path="apiReferenceLink" type="string" required={false} toc={true}>
413+
URL to your external API documentation or reference guide.
411414
</ParamField>
412415

413-
<ParamField path="readme.apiReferenceLink" type="string" required={false} toc={true}>
416+
<ParamField path="defaultEndpoint" type="ReadmeEndpointSchema" required={false} toc={true}>
417+
Specifies which endpoint's code snippet to showcase as the primary example in the README.
414418
</ParamField>
415419

416-
<ParamField path="readme.defaultEndpoint" type="ReadmeEndpointSchema" required={false} toc={true}>
420+
<ParamField path="features" type="map<string, list<ReadmeEndpointSchema>>" required={false} toc={true}>
421+
Groups endpoints by feature name for organized README sections. Each feature becomes a section in the README with example code snippets for the listed endpoints.
417422
</ParamField>
418423

419-
<ParamField path="readme.defaultEndpoint.method" type="string" required={true} toc={true}>
420-
</ParamField>
424+
### defaultEndpoint
425+
Specifies which endpoint's code snippet to showcase as the primary example in the README.
421426

422-
<ParamField path="readme.defaultEndpoint.path" type="string" required={true} toc={true}>
427+
<ParamField path="method" type="string" required={true} toc={true}>
428+
HTTP method of the default endpoint (e.g., `GET`, `POST`, `PUT`, `DELETE`).
423429
</ParamField>
424430

425-
<ParamField path="readme.defaultEndpoint.stream" type="boolean" required={false} toc={true}>
431+
<ParamField path="path" type="string" required={true} toc={true}>
432+
Endpoint path for the default example (e.g., `/users`, `/auth/login`).
426433
</ParamField>
427434

428-
<ParamField path="readme.features" type="map<string, list<ReadmeEndpointSchema>>" required={false} toc={true}>
435+
<ParamField path="stream" type="boolean" required={false} default="false" toc={true}>
436+
Whether the endpoint is a streaming endpoint. Defaults to `false`.
429437
</ParamField>
430438

431439
## default-group

0 commit comments

Comments
 (0)