Skip to content
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.

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

Document default-language configuration option in API reference setup guide #5334

Open
emrgnt-cmplxty opened this issue Dec 4, 2024 · 1 comment
Labels
documentation Related to buildwithfern.com/learn good first issue Looking to contribute to Fern? Start here! product/docs Fern Docs which builds and hosts a developer documentation site

Comments

@emrgnt-cmplxty
Copy link

Documentation Page URL

https://github.com/cohere-ai/cohere-developer-experience/blob/72ae51169c2cc288139e78890d9ac502c9def401/fern/docs.yml#L14

Issue Description

Description

Currently, the ability to configure the default programming language shown in the API reference (via default-language in docs.yml) is not documented. This setting is important for teams who want to customize the initial SDK example language their users see.

Current Status

  • The configuration option exists and works (default-language: python in docs.yml)
  • This functionality is not mentioned in our documentation

Proposed Changes

Add documentation explaining:

  • Where to set the default language (docs.yml)
  • Available language options
  • Example configuration
  • Default value if not specified

Example Documentation Section

## Configuring Default SDK Language

You can specify which programming language's SDK examples are shown by default in the API reference by setting `default-language` in your `docs.yml`:

```yaml
default-language: python

Available options include:

  • python
  • curl
  • [other supported languages]

## Labels
- documentation
- enhancement

### Steps to Reproduce (Optional)

_No response_

### Suggested Improvement

_No response_
@emrgnt-cmplxty emrgnt-cmplxty added the documentation Related to buildwithfern.com/learn label Dec 4, 2024
@dannysheridan dannysheridan added good first issue Looking to contribute to Fern? Start here! product/docs Fern Docs which builds and hosts a developer documentation site labels Dec 4, 2024
@dannysheridan
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to buildwithfern.com/learn good first issue Looking to contribute to Fern? Start here! product/docs Fern Docs which builds and hosts a developer documentation site
Development

No branches or pull requests

2 participants