Skip to content

feat(docs): add hide-related-topics layout option to docs.yml schema#16687

Open
kgowru wants to merge 2 commits into
mainfrom
devin/1782318978-add-hide-related-topics
Open

feat(docs): add hide-related-topics layout option to docs.yml schema#16687
kgowru wants to merge 2 commits into
mainfrom
devin/1782318978-add-hide-related-topics

Conversation

@kgowru

@kgowru kgowru commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Description

Linear ticket: Refs FER-11056

Companion PR to fern-platform#11952 which adds a "Related Topics" section at the bottom of docs pages. This PR adds the hide-related-topics option to the layout config in docs.yml so users can globally disable the feature.

# docs.yml
layout:
  hide-related-topics: true

Changes Made

  • Added hide-related-topics boolean property to LayoutConfig in the Fern API definition (fern/apis/docs-yml/definition/docs.yml)
  • Updated Zod schema in DocsYmlSchemas.ts
  • Updated SDK API type and serialization layer (LayoutConfig.ts)
  • Updated JSON schema (docs-yml.schema.json)
  • Updated convertLayoutConfig in parseDocsConfiguration.ts to pass through the new field (defaults to false)

Testing

  • pnpm compile passes for affected packages (configuration, configuration-loader, config)
  • pnpm lint:biome --fix and pnpm format:fix pass cleanly

Link to Devin session: https://app.devin.ai/sessions/e76abdb239f24b4fabff33b1a2464956
Requested by: @kgowru


Open in Devin Review

@kgowru kgowru self-assigned this Jun 24, 2026
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 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, CI, and merge conflict monitoring

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

devin-ai-integration Bot and others added 2 commits June 24, 2026 16:51
Co-Authored-By: Kapil Gowru <k.gowru@gmail.com>
Co-Authored-By: Kapil Gowru <k.gowru@gmail.com>
@devin-ai-integration devin-ai-integration Bot force-pushed the devin/1782318978-add-hide-related-topics branch from 34d594a to 8e8a3e6 Compare June 24, 2026 16:51
@github-actions

Copy link
Copy Markdown
Contributor

Docs Generation Benchmark Results

Comparing PR branch against median of 5 nightly run(s) on main (latest: 2026-06-24T05:18:39Z).

Fixture main PR Delta
docs 222.2s (n=5) 218.6s (35 versions) -3.6s (-1.6%)

Docs generation runs fern generate --docs --preview end-to-end against the benchmark fixture with 35 API versions (each version: markdown processing + OpenAPI-to-IR + FDR upload).
Delta is computed against the nightly baseline on main.
Baseline from nightly run(s) on main (latest: 2026-06-24T05:18:39Z). Trigger benchmark-baseline to refresh.
Last updated: 2026-06-24 17:21 UTC

@github-actions

Copy link
Copy Markdown
Contributor

SDK Generation Benchmark Results

Comparing PR branch against median of 5 nightly run(s) on main (latest: 2026-06-24T05:18:39Z).

Full benchmark table (click to expand)
Generator Spec main (generator) main (E2E) PR (generator) Delta
csharp-sdk square 76s (n=5) 109s (n=5) 63s -13s (-17.1%)
go-sdk square 134s (n=5) 283s (n=5) 125s -9s (-6.7%)
java-sdk square 214s (n=5) 285s (n=5) 191s -23s (-10.7%)
php-sdk square 59s (n=5) 85s (n=5) 53s -6s (-10.2%)
python-sdk square 130s (n=5) 241s (n=5) 131s +1s (+0.8%)
ruby-sdk-v2 square 92s (n=5) 129s (n=5) 90s -2s (-2.2%)
rust-sdk square 183s (n=5) 174s (n=5) 162s -21s (-11.5%)
swift-sdk square 57s (n=5) 431s (n=5) 50s -7s (-12.3%)
ts-sdk square 236s (n=5) 239s (n=5) 236s +0s (+0.0%)

main (generator): generator-only time via --skip-scripts (includes Docker image build, container startup, IR parsing, and code generation — this is the same Docker-based flow customers use via fern generate). main (E2E): full customer-observable time including build/test scripts (nightly baseline, informational). Delta is computed against generator-only baseline.
⚠️ = generation exited with a non-zero exit code (timing may not reflect a successful run).
Baseline from nightly runs on main (latest: 2026-06-24T05:18:39Z). Trigger benchmark-baseline to refresh.
Last updated: 2026-06-24 17:22 UTC

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.

1 participant