Document cross-link feature in library docs generator #5453
Merged
Conversation
Contributor
Author
|
Requested by: jon |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ## Cross-links in code blocks | ||
|
|
||
| When a fully-qualified identifier from your library appears inside a code block — for example, in a class signature or a type annotation — the generator turns it into a hyperlink to the page documenting that symbol. Readers can jump from a signature directly to the definition of any referenced class, module, or type without leaving the API reference. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Hyphens] 'fully-qualified' doesn't need a hyphen.
|
|
||
| ## Cross-links in code blocks | ||
|
|
||
| When a fully-qualified identifier from your library appears inside a code block — for example, in a class signature or a type annotation — the generator turns it into a hyperlink to the page documenting that symbol. Readers can jump from a signature directly to the definition of any referenced class, module, or type without leaving the API reference. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.
Contributor
|
🌿 Preview your docs: https://fern-preview-fern-cross-link-library-docs.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
| The library docs generator parses your **Python or C++** library source code and generates MDX documentation pages for modules, classes, functions, methods, and parameters. Generated pages include cross-reference links and hierarchical navigation, and are integrated directly into your Fern Docs site. | ||
| The library docs generator parses your **Python or C++** library source code and generates MDX documentation pages for modules, classes, functions, methods, and parameters. Generated pages are added to your Fern Docs site with hierarchical navigation. | ||
|
|
||
| Cross-links are automatic. When a fully-qualified identifier appears in a code block — for example, in a class signature or type annotation — the generator links it to the page documenting that symbol, so readers can jump straight to the definition. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Hyphens] 'fully-qualified' doesn't need a hyphen.
devalog
approved these changes
May 11, 2026
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
1 participant
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.
Summary
Documents the cross-link feature in the library docs generator. When a fully-qualified identifier from a library appears inside a code block (e.g., in a class signature or type annotation), the generator turns it into a hyperlink to the page documenting that symbol.
The existing page briefly mentioned "cross-reference links" in the intro but didn't explain or show the feature. This adds a dedicated section with the Benchling SDK example.
Changes
Requested by: Fern Support