Skip to content

Commit 3191415

Browse files
promptless[bot]devalog
authored andcommitted
Documentation updates from Promptless
1 parent 2bc75db commit 3191415

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

fern/products/sdks/snippets/readme-options.mdx

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,27 @@ readme:
1010
method: "POST"
1111
path: "/users"
1212
stream: false
13+
customSections:
14+
- title: "Usage"
15+
language: "JAVA"
16+
content: |
17+
Add the following dependency to your project:
18+
19+
```xml
20+
<dependency>
21+
<groupId>{{ group }}</groupId>
22+
<artifactId>{{ artifact }}</artifactId>
23+
<version>{{ version }}</version>
24+
</dependency>
25+
```
26+
- title: "Getting Started"
27+
language: "PYTHON"
28+
content: |
29+
Install the SDK using pip:
30+
31+
```bash
32+
pip install {{ package }}=={{ version }}
33+
```
1334
features:
1435
authentication:
1536
- method: "POST"
@@ -46,6 +67,29 @@ readme:
4667
Specifies which endpoint's code snippet to showcase as the primary example in the README.
4768
</ParamField>
4869

70+
<ParamField path="customSections" type="array" required={false} toc={true}>
71+
Each item in the array defines a custom section with specific language, title, and content.
72+
The sections are added to the generated README file for the specified language.
73+
74+
<ParamField path="title" type="string" required={true}>
75+
The title of the custom section.
76+
</ParamField>
77+
<ParamField path="language" type="'JAVA' | 'PYTHON' | 'TYPESCRIPT' | 'NODE' | 'C_SHARP' | 'GO' | 'PHP' | 'RUBY'" required={true}>
78+
The language for which this section should be added. Use the values:
79+
- 'JAVA'
80+
- 'PYTHON'
81+
- 'TYPESCRIPT'
82+
- 'NODE'
83+
- 'C_SHARP'
84+
- 'GO'
85+
- 'PHP'
86+
- 'RUBY'
87+
</ParamField>
88+
<ParamField path="content" type="string" required={true}>
89+
The Markdown content of the custom section. You can use template variables like `{{ group }}`, `{{ artifact }}`, and `{{ version }}` within the Markdown content.
90+
</ParamField>
91+
</ParamField>
92+
4993
<ParamField path="features" type="map<string, list<ReadmeEndpointSchema>>" required={false} toc={true}>
5094
Organizes endpoints into named feature sections within the README. Each feature creates a dedicated section with example code snippets for the specified endpoints.
5195
</ParamField>

0 commit comments

Comments
 (0)