Skip to content

docs: add YAML schema validation for product.yml and generators.yml#3506

Merged
Ryan-Amirthan merged 6 commits into
mainfrom
fern/document-product-yml-schema
Feb 6, 2026
Merged

docs: add YAML schema validation for product.yml and generators.yml#3506
Ryan-Amirthan merged 6 commits into
mainfrom
fern/document-product-yml-schema

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot commented Feb 5, 2026

docs: add YAML schema validation for product.yml and generators.yml

Summary

Adds "YAML schema validation" sections documenting the yaml-language-server schema directive to two pages, following the same pattern already used on the site-level settings page for docs.yml:

  1. Product switching — documents product-yml.schema.json for product .yml files, placed inside the "Define your products" step
  2. generators.yml reference — documents generators-yml.json for generators.yml files

Updates since last revision

  • Moved the product.yml schema validation info from a standalone ### YAML schema validation section into the "Define your products" step, per reviewer feedback. This reads more naturally since the step already introduces product .yml files.

Review & Testing Checklist for Human

  • Verify both schema URLs resolve correctly:
    • https://raw.githubusercontent.com/fern-api/fern/main/product-yml.schema.json
    • https://schema.buildwithfern.dev/generators-yml.json
  • On the products preview page, confirm the schema validation blurb reads well inside the "Define your products" step (renders correctly within the <Step> component)
  • On the generators.yml preview page, confirm the ### YAML schema validation heading and code block render correctly

Notes

Requested by: Fern Support
Link to Devin run

@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 5, 2026

🌿 Preview your docs: https://fern-preview-47f28d5d-591e-423f-8828-e5ebf66c21c9.docs.buildwithfern.com/learn

Visual changes detected:

fern/products/docs/pages/navigation/products.mdx

Page: learn/docs/configuration/products | Change: 39.383365177503656%

Comparison image available in workflow artifacts

fern/products/docs/pages/navigation/products.mdx

Page: learn/docs/configuration/products | Change: 2.3878973637347243%

fern/products/docs/pages/navigation/products.mdx comparison

fern/products/docs/pages/navigation/products.mdx

Page: learn/docs/configuration/products | Change: 0.5524542205928642%

fern/products/docs/pages/navigation/products.mdx comparison

fern/products/sdks/reference/generators-yml-reference.mdx

Page: learn/sdks/reference/generators-yml | Change: 95.85650640647432%

Comparison image available in workflow artifacts

@devin-ai-integration devin-ai-integration Bot changed the title docs: add YAML schema validation for product.yml files docs: add YAML schema validation for product.yml and generators.yml Feb 5, 2026
@Ryan-Amirthan Ryan-Amirthan self-requested a review February 6, 2026 00:50
@Ryan-Amirthan Ryan-Amirthan merged commit d677840 into main Feb 6, 2026
2 checks passed
@Ryan-Amirthan Ryan-Amirthan deleted the fern/document-product-yml-schema branch February 6, 2026 00:52
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