Customize README

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.

1
readme:
2
  introduction: "Welcome to our API"
3
  apiReferenceLink: "https://docs.example.com"
4
  defaultEndpoint:
5
    method: "POST"
6
    path: "/users"
7
  features:
8
    authentication:
9
      - method: "POST"
10
        path: "/auth/login"
11
    users:
12
      - method: "GET"
13
        path: "/users"

For more detailed information on readme configuration, see the generators.yml documentation