Document api:apiName link syntax for API Reference sections#4932
Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Open
Document api:apiName link syntax for API Reference sections#4932devin-ai-integration[bot] wants to merge 1 commit intomainfrom
api:apiName link syntax for API Reference sections#4932devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Conversation
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:
|
|
|
||
| ## Link to API Reference sections with `api:` syntax | ||
|
|
||
| The `api:` link syntax supports linking to the root of an API Reference section in addition to individual endpoints. Use `api:apiName` to create a link that resolves to the landing page of a specific API Reference at build time. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Microsoft.Wordiness] Consider using 'also' instead of 'in addition'.
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1776194577-document-api-apiname-links.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: Anar Kafkas <anarkafkas@gmail.com>
025218f to
87a98ee
Compare
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.
Summary
Documents the new
api:apiNameMDX link syntax added in fern-platform#9726, which allows docs authors to link to the root of an API Reference section (not just individual endpoints).Changes:
fern/snippets/api-link-syntax.mdx: Broadened the shared snippet to cover both endpoint links (api:METHOD/path) and the new section links (api:apiName), with an example and rendered preview.markdown-basics.mdxandapi-ref-content.mdx: Updated section headings from "Link to an API endpoint" / "Linking to API endpoints" → "API link syntax" since the snippet now covers both link types.2026-04-14.mdx): Appended a Docs changelog entry for the new feature (merged with the existing AI search model update entry for the same date).Review & Testing Checklist for Human
### Link to an API endpoint→### API link syntax(inmarkdown-basics.mdx) and## Linking to API endpoints→## API link syntax(inapi-ref-content.mdx). Check whether any other pages or external resources link to the old anchors (#link-to-an-api-endpoint,#linking-to-api-endpoints). Consider adding redirects if needed./learn/docs/writing-content/markdown-basics#api-link-syntax, which depends on the new heading slug.Notes
api:plant-storeexample in the snippet is a placeholder following the plant-themed content convention. It won't resolve to a real link on the docs site, but it appears only inside a code block and a highlight-frame demo.in addition→also) was left as-is for readability.Link to Devin session: https://app.devin.ai/sessions/9f5fa9caeb794b968d1e83c7644308c3
Requested by: @kafkas