Skip to content

add descriptions for readme config fields in generators.yml reference #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 29, 2025
Merged

add descriptions for readme config fields in generators.yml reference #204

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a082f09
add descriptions for readme config fields in generators.yml reference
tstanmay13 Jul 28, 2025
70bd8fa
formatting fixes and removing some redundancy
tstanmay13 Jul 29, 2025
4e8628b
Update fern/products/sdks/reference/generators-yml-reference.mdx
tstanmay13 Jul 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 19 additions & 11 deletions fern/products/sdks/reference/generators-yml-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ metadata:
</ParamField>

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

```yaml
readme:
Expand All @@ -401,31 +401,39 @@ readme:
path: "/users"
```

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

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

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

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

<ParamField path="readme.defaultEndpoint" type="ReadmeEndpointSchema" required={false} toc={true}>
<ParamField path="features" type="map<string, list<ReadmeEndpointSchema>>" required={false} toc={true}>
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.
</ParamField>

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

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

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

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

## default-group
Expand Down