search

fern-api / fern

Input OpenAPI. Output SDKs and Docs.
https://buildwithfern.com
MIT License
2.45k stars 118 forks source link

(feature, readme): Add support for configurable introduction #3898

Closed amckinney closed 1 week ago

amckinney commented 1 week ago

This adds support for an optional introduction configuration value in the user's readme block. For example,

# generators.yml
readme:
  introduction: |
    The Acme SDK allows access to the Acme API.
  bannerLink: https://raw.githubusercontent.com/acme/acme/banner.png
  docs: http://docs.acme.co

groups:
  ...

If not specified, the default introduction will be used. Note that this will require an IR upgrade (i.e. IRv48) for each generator to use.