Skip to content

Cross-link Vale and LLM output pages; note Vale linting of llms-ignore blocks #6374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fern-api wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −0
Open

Cross-link Vale and LLM output pages; note Vale linting of llms-ignore blocks #6374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions fern/products/docs/pages/ai/llms-txt/customize-llms-txt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ The guiding principle: **UI-only elements belong to human readers, and their pro

To preview and debug what AI sees for any page, you can append `.md` or `.mdx` to the page URL to [view its Markdown source](/learn/docs/ai-features/markdown).

Both blocks stay in your MDX source, so source-level tooling like [Vale](/learn/docs/developer-tools/vale) lints their contents regardless of which audience receives the rendered output.

## Filter endpoint output

Filter `llms.txt` output with the `lang` and `excludeSpec` query parameters to reduce token usage. Parameters can also be combined.
Expand Down
2 changes: 2 additions & 0 deletions fern/products/docs/pages/developer-tools/vale.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ const plant = await client.createPlant({
Vale will start checking this text again.
````

Vale lints your MDX source, so content inside [`<llms-only>` and `<llms-ignore>`](/learn/docs/ai-features/customize-llm-output#filter-within-a-page) blocks is still checked even though those tags filter what humans and LLMs receive. Wrap a block in `vale off`/`vale on` to exclude it from linting.

</Step>
<Step title="Automate Vale (optional)">
Consider integrating Vale into your workflow so it runs automatically for all contributors:
Expand Down
Loading