Cross-link Vale and LLM output pages; note Vale linting of llms-ignore blocks - #6374
Open
fern-api[bot] wants to merge 1 commit into
Open
Cross-link Vale and LLM output pages; note Vale linting of llms-ignore blocks
#6374fern-api[bot] wants to merge 1 commit into
fern-api[bot] wants to merge 1 commit into
Conversation
… LLM output pages
Contributor
Author
|
Requested by: devin.logan |
Contributor
|
🌿 Preview your docs: https://fern-preview-fern-vale-llms-crossref.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a short note to the Vale page explaining that Vale lints MDX source, so content inside
<llms-only>and<llms-ignore>blocks is still checked, and that wrapping a block invale off/vale onexcludes it from linting.Also adds bidirectional cross-references between the Vale page and the Customize LLM output page.
Changes
developer-tools/vale.mdx: note on howvale off/vale oninteracts with<llms-only>/<llms-ignore>, linking to Customize LLM output.ai/llms-txt/customize-llms-txt.mdx: sentence noting these blocks stay in MDX source and are linted by tooling like Vale, linking to the Vale page.Requested by: Fern Support