Document codeblock deep-linking feature #1472
Merged
Conversation
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
Add documentation for the new deep-linking feature in code blocks that allows defining a links map to make specific text clickable. Includes examples for exact string matching, regex pattern matching, and combining both approaches. Co-Authored-By: Catherine Deskur <catherine@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:
|
Contributor
- Created new hidden demo page at /docs/writing-content/demo with API documentation examples - Updated all deep-linking examples in code-blocks.mdx to link to demo page sections - Added demo page to docs.yml navigation with hidden: true flag - Demo page includes PlantClient, PlantConfig, createPlant, create_plant, fetchPlants, and PlantResponse examples Co-Authored-By: Catherine Deskur <catherine@buildwithfern.com>
Contributor
Contributor
Contributor
Contributor
Contributor
Contributor
Contributor
Contributor
Contributor
Contributor
…61574359-document-codeblock-deep-linking
Contributor
Contributor
devalog
approved these changes
Oct 27, 2025
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.
Add hidden demo page for deep-linking examples
Summary
Created a hidden demo page to make the codeblock deep-linking feature examples functional. The deep-linking documentation now links to real content instead of placeholder URLs, making the feature more tangible and testable.
Changes:
/docs/writing-content/demo) with API documentation examples (PlantClient, PlantConfig, createPlant, etc.)hidden: trueflag so it doesn't appear in the sidebar but remains accessible via direct linksThe demo page is designed to be reusable for future component demonstrations beyond just deep-linking.
Review & Testing Checklist for Human
/docs/writing-content/demo#sectionbut may need/learnprefix (check if links are broken or working)Test the regex examples to ensure patterns like
Plant\w+correctly match and link PlantClient, PlantConfig, and PlantResponse in the code blocksVerify the demo page is properly hidden from the navigation sidebar but still accessible via direct link
Test the exact string matching examples (TypeScript example with PlantClient and createPlant)
Test Plan
/docs/writing-content/demo#plantclient/docs/writing-content/demo#createplantPlant\w+pattern/docs/writing-content/demo(or/learn/docs/writing-content/demo) to ensure the page loadsNotes
fern docs devand verified the page renders correctly, but couldn't fully test the deep-linking functionality as it requires the actual feature implementation