Skip to content

Commit 1e93bd4

Browse files
authored
Fix formatting for Generator metadata and Snippets configuration sections in generators.yml reference page (#208)
1 parent 2d4484a commit 1e93bd4

File tree

1 file changed

+39
-6
lines changed

1 file changed

+39
-6
lines changed

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

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -785,24 +785,57 @@ Specify which teams and users should review generated code. See [reviewers confi
785785

786786
### Generator Metadata
787787

788-
<ParamField path="groups.{groupName}.generators[].metadata.package-description" type="string" required={false} toc={true}>
788+
Specify metadata for your SDK generator.
789+
790+
```yml {6-10}
791+
groups:
792+
ts-sdk:
793+
generators:
794+
- name: fernapi/fern-typescript-sdk
795+
...
796+
metadata:
797+
package-description: "Description of your SDK"
798+
799+
reference-url: "https://docs.example.com/sdks"
800+
license: "MIT"
801+
```
802+
803+
<ParamField path="package-description" type="string" required={false} toc={true}>
804+
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.
789805
</ParamField>
790806

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

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

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

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

803823
### Snippets Configuration
804824

805-
<ParamField path="groups.{groupName}.generators[].snippets.path" type="string" required={true} toc={true}>
825+
Configures snippets for a particular generator.
826+
827+
```yml {6-8}
828+
groups:
829+
ts-sdk:
830+
generators:
831+
- name: fernapi/fern-typescript-sdk
832+
...
833+
snippets:
834+
path: "./snippets"
835+
```
836+
837+
<ParamField path="path" type="string" required={true} toc={true}>
838+
The path to the generated snippets file.
806839
</ParamField>
807840

808841
### API Settings Override

0 commit comments

Comments
 (0)