docs: add llms-ignore and llms-only tags to overview and home pages#4678
docs: add llms-ignore and llms-only tags to overview and home pages#4678
Conversation
|
🌿 Preview your docs: https://fern-preview-fern-llms-ignore-overview-styling.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
|
Requested by: devin |
| <llms-only> | ||
| ## Get started | ||
|
|
||
| Build a docs site quickly by importing your existing styling and specs. |
There was a problem hiding this comment.
📝 [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. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'easily' if it's not important to the meaning of the statement.
fern/products/home/pages/welcome.mdx
Outdated
|
|
||
| ## Community | ||
|
|
||
| - [Changelog](/docs/changelog): See our most recent product updates. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.We] Try to avoid using first-person plural like 'our'.
fern/products/home/pages/welcome.mdx
Outdated
|
|
||
| ## Help | ||
|
|
||
| We're lightning-fast with support! If you're a customer, reach out via your dedicated Slack channel. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.We] Try to avoid using first-person plural like 'We'.
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 inllms.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 sectionsfern/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 sectionsUpdates since last revision
<llms-only>blocks only (original HTML in<llms-ignore>left untouched):Review & Testing Checklist for Human
<llms-ignore>tags should not affect browser rendering)<llms-only>content appears instead<llms-only>blocks — some use/learn/prefix and some don't, mirroring the original markup. Verify these resolve correctly in the llms.txt context<llms-only>content accurately reflects all card titles, descriptions, and links from the original custom JSX (manually extracted — potential for mismatches or omissions)Notes
<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).welcome.mdx) is ~400 lines of custom HTML; the entire page body is wrapped.<llms-only>blocks, not to the original content inside<llms-ignore>.Link to Devin session: https://app.devin.ai/sessions/d9a2abffd71e4c9b86f69e78c24366e2