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 1 commit
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
9 changes: 9 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 @@ -402,30 +402,39 @@ readme:
```

<ParamField path="readme" type="ReadmeSchema" required={false} toc={true}>
Copy link
Collaborator

@devalog devalog Jul 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since readme is the top-level option, I think you can actually remove the ParamField formatting and move the description up above the yaml code block. (Might need to do some wordsmithing to merge it with the existing description.)

Configuration for customizing the generated README files.
</ParamField>

<ParamField path="readme.bannerLink" type="string" required={false} toc={true}>
Copy link
Collaborator

@devalog devalog Jul 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For all of these, could you take out the "readme."? It's a bit more user friendly. (Context: I'm the one who structured it this way in the first place😬, but I'm slowly going through and trying to improve this page section by section.)

example: path="readme.bannerLink" --> path="bannerLink"

URL for a banner image or link that appears at the top of the README.
</ParamField>

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

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

<ParamField path="readme.defaultEndpoint" type="ReadmeEndpointSchema" required={false} toc={true}>
Copy link
Collaborator

@devalog devalog Jul 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can make defaultEndpoint a new subsection

### defaultEndpoint
Specifies which endpoint's code snippet to showcase as the primary example in the README.

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

etc

Context: I'm trying to do something similar in this outstanding PR: #175

Specifies which endpoint's code snippet to showcase as the primary example in the README.
</ParamField>

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

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

<ParamField path="readme.defaultEndpoint.stream" type="boolean" required={false} toc={true}>
Whether the endpoint is a streaming endpoint. Defaults to `false`.
</ParamField>

<ParamField path="readme.features" type="map<string, list<ReadmeEndpointSchema>>" required={false} toc={true}>
Copy link
Collaborator

@devalog devalog Jul 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you have the time, I think it would be great to have features as another subsection and then separate ParamFields for each feature name ie authentication, users, and their subfields.

Copy link
Collaborator

@devalog devalog Jul 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also feel free to skip this, definitely ok to merge your changes without adding this info!

Copy link
Contributor Author

@tstanmay13 tstanmay13 Jul 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good I will pick up this as an item for later then!

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>

## default-group
Expand Down