Skip to content

Fix formatting for Generator metadata and Snippets configuration sections in generators.yml reference page #208

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
Jul 29, 2025
Merged

Fix formatting for Generator metadata and Snippets configuration sections in generators.yml reference page #208

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e85eae5
update generators metadata section
devalog Jul 29, 2025
b42820b
merge
devalog Jul 29, 2025
0eab21c
edit snippets config
devalog Jul 29, 2025
6d5137e
fix error
devalog 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
45 changes: 39 additions & 6 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 @@ -785,24 +785,57 @@ Specify which teams and users should review generated code. See [reviewers confi

### Generator Metadata

<ParamField path="groups.{groupName}.generators[].metadata.package-description" type="string" required={false} toc={true}>
Specify metadata for your SDK generator.

```yml {6-10}
groups:
ts-sdk:
generators:
- name: fernapi/fern-typescript-sdk
...
metadata:
package-description: "Description of your SDK"
email: "[email protected]"
reference-url: "https://docs.example.com/sdks"
license: "MIT"
```

<ParamField path="package-description" type="string" required={false} toc={true}>
A brief description of what your generated SDK does and its key features. This appears in the `package.json` description field and package registry listings.
</ParamField>

<ParamField path="groups.{groupName}.generators[].metadata.email" type="string" required={false} toc={true}>
<ParamField path="email" type="string" required={false} toc={true}>
Contact email for the package maintainer or support team.
</ParamField>

<ParamField path="groups.{groupName}.generators[].metadata.reference-url" type="string" required={false} toc={true}>
<ParamField path="reference-url" type="string" required={false} toc={true}>
URL pointing to comprehensive documentation, API reference, or getting started guide for the SDK.
</ParamField>

<ParamField path="groups.{groupName}.generators[].metadata.author" type="string" required={false} toc={true}>
<ParamField path="author" type="string" required={false} toc={true}>
Name of the individual developer, team, or organization that created and maintains the SDK.
</ParamField>

<ParamField path="groups.{groupName}.generators[].metadata.license" type="GithubLicenseSchema" required={false} toc={true}>
<ParamField path="license" type="'MIT' | 'Apache-2.0' | { custom: 'Custom License Name' }" required={false} toc={true}>
Software license for the generated SDK.
</ParamField>

### Snippets Configuration

<ParamField path="groups.{groupName}.generators[].snippets.path" type="string" required={true} toc={true}>
Configures snippets for a particular generator.

```yml {6-8}
groups:
ts-sdk:
generators:
- name: fernapi/fern-typescript-sdk
...
snippets:
path: "./snippets"
```

<ParamField path="path" type="string" required={true} toc={true}>
The path to the generated snippets file.
</ParamField>

### API Settings Override
Expand Down