Skip to content

Document api:apiName link syntax for API Reference sections#4932

Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1776194577-document-api-apiname-links
Open

Document api:apiName link syntax for API Reference sections#4932
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1776194577-document-api-apiname-links

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot commented Apr 14, 2026

Summary

Documents the new api:apiName MDX 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.
  • Heading renames in markdown-basics.mdx and api-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.
  • Changelog entry (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

  • Broken anchor links from heading renames: The headings changed from ### Link to an API endpoint### API link syntax (in markdown-basics.mdx) and ## Linking to API endpoints## API link syntax (in api-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.
  • Verify the changelog "Read the docs" button resolves correctly: it points to /learn/docs/writing-content/markdown-basics#api-link-syntax, which depends on the new heading slug.
  • Preview the rendered snippet on both pages where it's included (markdown-basics and api-ref-content) to confirm the new section reads well in context.

Notes

  • The api:plant-store example 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.
  • Vale passes with 0 errors and 0 warnings. The single remaining suggestion (in additionalso) was left as-is for readability.

Link to Devin session: https://app.devin.ai/sessions/9f5fa9caeb794b968d1e83c7644308c3
Requested by: @kafkas

@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

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


## 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.
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.

📝 [vale] reported by reviewdog 🐶
[Microsoft.Wordiness] Consider using 'also' instead of 'in addition'.

@github-actions
Copy link
Copy Markdown
Contributor

Co-Authored-By: Anar Kafkas <anarkafkas@gmail.com>
@devin-ai-integration devin-ai-integration bot force-pushed the devin/1776194577-document-api-apiname-links branch from 025218f to 87a98ee Compare April 14, 2026 19:53
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