Skip to content

docs: add llms-ignore and llms-only tags to overview and home pages#4678

Merged
devalog merged 4 commits intomainfrom
fern/llms-ignore-overview-styling
Mar 31, 2026
Merged

docs: add llms-ignore and llms-only tags to overview and home pages#4678
devalog merged 4 commits intomainfrom
fern/llms-ignore-overview-styling

Conversation

@fern-api
Copy link
Copy Markdown
Contributor

@fern-api fern-api bot commented Mar 31, 2026

Summary

Wraps the custom-styled HTML/JSX on both the Docs overview page and the Home page with <llms-ignore> tags so the custom card markup, images, and CSS classes don't render in llms.txt. Adds <llms-only> blocks with clean markdown equivalents so LLMs still receive the useful content (titles, descriptions, and links).

Files changed:

  • fern/products/docs/pages/getting-started/overview.mdx — wrapped <div className="docs-homepage"> in <llms-ignore>, added <llms-only> with Get Started and Features sections
  • fern/products/home/pages/welcome.mdx — wrapped <div className="lp-page-container"> in <llms-ignore>, added <llms-only> with SDKs, Docs, Ask Fern, Supported Specs, Community, and Help sections

Updates since last revision

  • Fixed Vale style suggestions in <llms-only> blocks only (original HTML in <llms-ignore> left untouched):
    • Removed adverbs "quickly" and "easily" (overview.mdx)
    • Changed "our" → "the" in changelog description (welcome.mdx)
    • Changed "We're lightning-fast with support!" → "Fern offers lightning-fast support." (welcome.mdx)

Review & Testing Checklist for Human

  • Verify the overview preview and home preview render correctly with no visual regressions (the <llms-ignore> tags should not affect browser rendering)
  • Check llms.txt to confirm the raw HTML/CSS card markup is no longer present and the clean markdown <llms-only> content appears instead
  • Spot-check links in the <llms-only> blocks — some use /learn/ prefix and some don't, mirroring the original markup. Verify these resolve correctly in the llms.txt context
  • Confirm the <llms-only> content accurately reflects all card titles, descriptions, and links from the original custom JSX (manually extracted — potential for mismatches or omissions)

Notes

  • The <llms-only> content was manually extracted from the custom JSX cards. All titles, descriptions, and hrefs were preserved as-is from the original markup (with minor Vale-driven rewording).
  • The home page (welcome.mdx) is ~400 lines of custom HTML; the entire page body is wrapped.
  • Vale fixes were applied only to the new <llms-only> blocks, not to the original content inside <llms-ignore>.

Link to Devin session: https://app.devin.ai/sessions/d9a2abffd71e4c9b86f69e78c24366e2

@fern-api fern-api bot requested a review from devalog as a code owner March 31, 2026 20:25
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 31, 2026

🌿 Preview your docs: https://fern-preview-fern-llms-ignore-overview-styling.docs.buildwithfern.com/learn

Here are the markdown pages you've updated:

@fern-api
Copy link
Copy Markdown
Contributor Author

fern-api bot commented Mar 31, 2026

Requested by: devin
Slack thread: View conversation

<llms-only>
## Get started

Build a docs site quickly by importing your existing styling and specs.
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 🐶
[FernStyles.Adverbs] Remove 'quickly' if it's not important to the meaning of the statement.


## Features

Build your own components, enable Ask Fern, generate API references, and easily update your docs.
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 🐶
[FernStyles.Adverbs] Remove 'easily' if it's not important to the meaning of the statement.

@devin-ai-integration devin-ai-integration bot changed the title docs: wrap custom styling on overview page with llms-ignore tags docs: add llms-ignore and llms-only tags to overview and home pages Mar 31, 2026

## Community

- [Changelog](/docs/changelog): See our most recent product updates.
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 🐶
[FernStyles.We] Try to avoid using first-person plural like 'our'.


## Help

We're lightning-fast with support! If you're a customer, reach out via your dedicated Slack channel.
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 🐶
[FernStyles.We] Try to avoid using first-person plural like 'We'.

@devalog devalog merged commit 225d269 into main Mar 31, 2026
2 checks passed
@devalog devalog deleted the fern/llms-ignore-overview-styling branch March 31, 2026 22:13
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