Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Oct 19, 2025

Document Anchor component

Summary

Adds documentation for a new <Anchor /> MDX component that creates custom anchor points inside content. The docs explain usage, the required id prop, and include rendered/markdown examples showing how to wrap tables and code blocks. The component page is linked in the Component Library navigation.

Changes:

  • New page: fern/products/docs/pages/component-library/default-components/anchor.mdx
  • Navigation: Added "Anchor" entry under Component Library > Default Components with link icon

Review & Testing Checklist for Human

3 items

  • Verify that <Anchor /> is available in the docs runtime (MDX component registry) and renders without the "Unsupported JSX tag" fallback. If the component isn't yet in fern-platform's MDX components, this page will not render correctly—coordinate merge order accordingly.
  • Run the docs locally (fern docs dev) and navigate to Component Library → Default Components → Anchor. Confirm:
    • The examples render correctly (table wrapped in Anchor, code block wrapped in Anchor)
    • Clicking links to #api-endpoints and #example-code scrolls to the corresponding anchored content sections
    • The component works for non-heading content, and headings continue to have their default auto-generated anchors
  • Check navigation placement and icon: Ensure the "Anchor" page appears in the Components list alphabetically and the fa-link icon looks correct alongside other entries

Recommended test plan:

  1. Pull this branch and run: fern docs dev
  2. Visit http://localhost:3000 and open the Anchor page via: Writing content → Components → Anchor
  3. Validate the examples:
  4. Optional: Try adding a custom Anchor with a unique id on a local page to ensure no id collisions and proper scroll behavior

Notes

- Add documentation for the <Anchor /> component
- Include usage examples and properties
- Add to navigation in docs.yml

Co-Authored-By: Catherine Deskur <[email protected]>
@devin-ai-integration
Copy link
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

@github-actions
Copy link
Contributor

- Replace header-wrapping example with table example
- Add code block example
- Both examples show practical use cases for anchoring non-heading content

Co-Authored-By: Catherine Deskur <[email protected]>
@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@devalog devalog merged commit df1ae68 into main Oct 27, 2025
2 checks passed
@devalog devalog deleted the devin/1760901170-document-anchor-component branch October 27, 2025 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants