Skip to content

Update ReadmeConfig docs #683

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 4 commits into from
Sep 4, 2025
+16 −0
Merged

Update ReadmeConfig docs #683

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3d45e81
inital change
jsklan Sep 3, 2025
7be164c
Merge branch 'main' into jsklan/update-readme-docs
jsklan Sep 3, 2025
6887c28
updates
jsklan Sep 3, 2025
938bef7
feedback
jsklan Sep 4, 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
2 changes: 2 additions & 0 deletions fern/apis/generators-yml/definition/generators.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ types:
bannerLink: optional<string>
introduction: optional<string>
apiReferenceLink: optional<string>
apiName: optional<string>
disabledSections: optional<list<string>>
defaultEndpoint:
type: optional<ReadmeEndpointSchema>
docs: "If set, use this endpoint's snippet as the default whenever possible"
Expand Down
3 changes: 3 additions & 0 deletions fern/products/sdks/guides/configure-readme.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ You can add custom introductions, showcase key endpoints, and organize your SDK
readme:
introduction: "Welcome to our API"
apiReferenceLink: "https://docs.example.com"
apiName: "Example Product"
disabledSections:
- "contributing"
defaultEndpoint:
method: "POST"
path: "/users"
Expand Down
11 changes: 11 additions & 0 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 @@ -337,6 +337,9 @@ readme:
bannerLink: "https://example.com/banner"
introduction: "Welcome to our API"
apiReferenceLink: "https://docs.example.com"
apiName: "Example Product"
disabledSections:
- "contributing"
defaultEndpoint:
method: "POST"
path: "/users"
Expand Down Expand Up @@ -365,6 +368,14 @@ readme:
URL to your external API documentation or reference guide.
</ParamField>

<ParamField path="apiName" type="string" required={false} toc={true}>
Name of the API that appears in the README. Will appear as `Your Api Name SDK` or `Your Api Name API` throughout the README. Defaults to organization name if not set.
</ParamField>

<ParamField path="disabledSections" type="string[]" required={false} toc={true}>
Sections to disable in the README (e.g. `contributing`).
</ParamField>

<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>
Expand Down