Add llms-only FAQ sections to five high-traffic pages - #6795
Add llms-only FAQ sections to five high-traffic pages#6795fern-api[bot] wants to merge 1 commit into
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'don't' instead of 'do not'.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'isn't' instead of 'is not'.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.
docs/fern/products/home/pages/welcome.mdx
Line 440 in ee426db
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'what's' instead of 'What is'.
docs/fern/products/home/pages/welcome.mdx
Line 442 in ee426db
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 442 in ee426db
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/home/pages/welcome.mdx
Line 442 in ee426db
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 445 in ee426db
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/home/pages/welcome.mdx
Line 445 in ee426db
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/home/pages/welcome.mdx
Line 448 in ee426db
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 448 in ee426db
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'what's' instead of 'What is'.
docs/fern/products/home/pages/welcome.mdx
Line 451 in ee426db
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 451 in ee426db
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/home/pages/welcome.mdx
Line 451 in ee426db
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 454 in ee426db
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/home/pages/welcome.mdx
Line 454 in ee426db
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 454 in ee426db
📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.
docs/fern/products/sdks/introduction.mdx
Line 294 in ee426db
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/sdks/introduction.mdx
Line 296 in ee426db
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/sdks/introduction.mdx
Line 296 in ee426db
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
docs/fern/products/sdks/introduction.mdx
Line 299 in ee426db
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/sdks/introduction.mdx
Line 299 in ee426db
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/sdks/introduction.mdx
Line 299 in ee426db
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/sdks/introduction.mdx
Line 302 in ee426db
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/sdks/introduction.mdx
Line 302 in ee426db
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
docs/fern/products/sdks/introduction.mdx
Line 305 in ee426db
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/sdks/introduction.mdx
Line 305 in ee426db
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/sdks/introduction.mdx
Line 305 in ee426db
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/sdks/introduction.mdx
Line 308 in ee426db
Avoid time-relative terms like 'latest' that become outdated
docs/fern/products/sdks/introduction.mdx
Line 309 in ee426db
|
|
||
| <llms-only> | ||
|
|
||
| ## Frequently Asked Questions |
There was a problem hiding this comment.
📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.
|
|
||
| ## Frequently Asked Questions | ||
|
|
||
| ### What can I build with Fern Docs? |
There was a problem hiding this comment.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
|
|
||
| ## Frequently Asked Questions | ||
|
|
||
| ### What can I build with Fern Docs? |
There was a problem hiding this comment.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
| ### What can I build with Fern Docs? | |
| ### What can I build with Fern Docs |
|
|
||
| ## Frequently Asked Questions | ||
|
|
||
| ### What can I build with Fern Docs? |
There was a problem hiding this comment.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
| ### What can I build with Fern Docs? | ||
| Fern Docs lets you build a complete developer documentation site: write pages in Markdown, generate API references from OpenAPI or other specs, add interactive components, enable AI search with Ask Fern, protect content with authentication and role-based access control, localize into multiple languages, and publish to a custom domain. | ||
|
|
||
| ### Does Fern Docs support API reference generation? |
There was a problem hiding this comment.
🚫 [vale] <FernStyles.Reject> reported by reviewdog 🐶
Use 'API Reference' instead of 'API reference'.
| ### Can I preview my Fern docs before publishing? | ||
| Yes. Run `fern docs dev` to start a local development server with hot-reloading, or run `fern generate --docs --preview` to generate a shareable preview URL you can send to teammates. | ||
|
|
||
| ### How do I add an API reference to my Fern docs? |
There was a problem hiding this comment.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
| ### Can I preview my Fern docs before publishing? | ||
| Yes. Run `fern docs dev` to start a local development server with hot-reloading, or run `fern generate --docs --preview` to generate a shareable preview URL you can send to teammates. | ||
|
|
||
| ### How do I add an API reference to my Fern docs? |
There was a problem hiding this comment.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
| ### How do I add an API reference to my Fern docs? | |
| ### How do I add an API reference to my Fern docs |
| ### Can I preview my Fern docs before publishing? | ||
| Yes. Run `fern docs dev` to start a local development server with hot-reloading, or run `fern generate --docs --preview` to generate a shareable preview URL you can send to teammates. | ||
|
|
||
| ### How do I add an API reference to my Fern docs? |
There was a problem hiding this comment.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
| Yes. Run `fern docs dev` to start a local development server with hot-reloading, or run `fern generate --docs --preview` to generate a shareable preview URL you can send to teammates. | ||
|
|
||
| ### How do I add an API reference to my Fern docs? | ||
| Add your OpenAPI spec to the project (or run `fern init --openapi /path/to/spec.yml`), then reference it in `docs.yml` with `- api: "API Reference"`. Fern will generate interactive API reference pages automatically on the next publish. |
There was a problem hiding this comment.
🚫 [vale] <FernStyles.Reject> reported by reviewdog 🐶
Use 'API Reference' instead of 'API reference'.
| ### How do I add an API reference to my Fern docs? | ||
| Add your OpenAPI spec to the project (or run `fern init --openapi /path/to/spec.yml`), then reference it in `docs.yml` with `- api: "API Reference"`. Fern will generate interactive API reference pages automatically on the next publish. | ||
|
|
||
| ### How do I publish Fern docs in a CI/CD pipeline? |
There was a problem hiding this comment.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
|
🌿 Preview your docs: https://fern-preview-2026-08-31-fern-ai-1fb7a4-2d2bff50.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Appended an SEO-focused
## Frequently Asked Questionssection wrapped in<llms-only>tags to the bottom of five pages: the Fern homepage (fern/products/home/pages/welcome.mdx, which serves the/learnhome content), the Docs capabilities and quickstart pages, the SDKs overview (fern/products/sdks/introduction.mdx), and the reverse proxy guide. Each block uses###questions with short paragraph answers grounded in the page's existing content, and nothing was added outside the<llms-only>wrapper, so human readers see no visible change.