Skip to content

🌿 Fern Scribe: Add a comprehensive list of all extension headers... #303

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

kgowru
Copy link
Contributor

@kgowru kgowru commented Aug 1, 2025

🌿 Fern Scribe Documentation Update

Original Request: Add a comprehensive list of all extension headers

Files Updated:

  • fern/products/openapi-def/pages/extensions/parameter-names.mdx
  • fern/products/sdks/overview/typescript/configuration.mdx
  • fern/products/sdks/overview/python/configuration.mdx

Priority: Medium

Related Discussion: https://buildwithfern.slack.com/archives/C0811KJCBL4/p1749843216981529

Additional Context: No response

⚠️ Files with MDX Validation Issues

The following files could not be updated due to MDX validation failures after 3 attempts:

These files may need manual review and correction of their MDX component structure.


This PR was automatically generated by Fern Scribe based on issue #266

Please review the changes carefully before merging.

Copy link
Contributor

github-actions bot commented Aug 1, 2025


```yaml {8}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed highlighting? Not sure why, highlighting would be useful for this.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original text had an explanation of what the example was doing. Retaining the specific explanation or even moving it to a comment in the code block would be better. I like that fern scribe added a general definition of the extension, though.

@@ -166,32 +207,4 @@ groups:

<ParamField path="use_typeddict_requests_for_file_upload" type="bool" default="false" required={false} toc={true}>
Whether or not to generate TypedDicts instead of Pydantic Models for file upload request objects. Note that this flag was only introduced due to an oversight in the `use_typeddict_requests` flag implementation; it should be removed in the future.
</ParamField>

### client
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fern scribe removed this separate section. I think the document/more reasable is better with the separate section.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also kind of a weird change because the client params aren't directly related to the extension headers afaik?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants