Skip to content

Visual Editor: Update #332

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Visual Editor: Update #332

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 3 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 @@ -3,8 +3,11 @@ title: Customize README
description: Guide to configuring the README in your SDK
---

By default, the README for your SDKs is generated programmatically. You can override this by configuring the `readme` section in `generators.yml` to control the content and structure of generated README files across all your SDKs.
You can add custom introductions, showcase key endpoints, and organize your SDK documentation with feature sections.
By default, the README for your SDKs is generated programmatically. You can override this by configuring the `readme` section in `generators.yml` to control the content and structure of generated README files across all your SDKs. You can add custom introductions, showcase key endpoints, and organize your SDK documentation with feature sections.

We also include templates for README generation

> The readme is super customizable

```yaml title="generators.yml"
readme:
Expand All @@ -22,4 +25,4 @@ readme:
path: "/users"
```

For more detailed information on `readme` configuration, see the [`generators.yml` documentation](/sdks/reference/generators-yml#readme)
For more detailed information on `readme` configuration, see the `generators.yml`[ documentation](/sdks/reference/generators-yml#readme)