fix(docs): prevent API reference title from inheriting child tag description overview page#14870
Merged
tdclarin258 merged 2 commits intomainfrom Apr 15, 2026
Conversation
…ription overview page When tag-description-pages is enabled, child apiPackage nodes get overviewPageIds from their tag descriptions. Previously, the parent API reference node would inherit the first child's overviewPageId, making the top-level API reference title clickable (navigating to a folder's tag description page). This was undesirable — the folder overview pages belong to the individual tag sections, not the parent. Now the inheritance is skipped when tagDescriptionPages is enabled, keeping the top-level API reference title as a non-clickable header. Co-Authored-By: tristan.declarin <tristan.declarin@buildwithfern.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.
Tip: disable this comment in your organization's Code Review settings.
sbawabe
approved these changes
Apr 13, 2026
…scription-pages Co-Authored-By: tristan.declarin <tristan.declarin@buildwithfern.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Refs: Related to fern-platform#9488
When
tag-description-pages: trueis set on an API reference, the top-level API reference title (e.g., "Salesforce Platform APIs") becomes clickable because it inherits the first child tag section'soverviewPageId. This is undesirable — the tag description overview pages belong to the individual folder/tag sections, not the parent API reference.Changes Made
!this.apiSection.tagDescriptionPages) to theoverviewPageIdinheritance logic inApiReferenceNodeConverter.get(). Whentag-description-pagesis enabled, the parent API reference no longer inherits a child apiPackage'soverviewPageId, keeping the top-level title as a non-clickable section header.tag-description-pages.test.tsthat assertsoverviewPageIdisundefinedon theApiReferenceNodewhentagDescriptionPagesis enabled, and verifies childapiPackagenodes still retain their ownoverviewPageIdvalues.Testing
@fern-api/docs-resolver)"does not inherit child tag overviewPageId when tag-description-pages is enabled"— verifiesnode.overviewPageIdisundefinedat the API reference level while child apiPackage nodes still have overview pagesrec-fe3b396175c74cc5af878f7d163b4aca-edited.mp4
Human Review Checklist
tag-description-pages: truewill no longer have a clickable top-level title (unless an explicitsummary/overview page is configured). Verify this is acceptable.DocsDefinitionResolver.toSectionNode()would inherit it). Confirm the flattened case doesn't need special handling.tag-description-pageswould need to set an explicitsummaryon the API reference. Confirm this is reasonable.Link to Devin session: https://app.devin.ai/sessions/1784b5d69de24f4fbaff5f83675e255e