chore: standardize prebuilt terminology and add vale linting [closes DOC-821]#2958
Draft
Naomi Pentrel (npentrel) wants to merge 1 commit intomainfrom
Draft
chore: standardize prebuilt terminology and add vale linting [closes DOC-821]#2958Naomi Pentrel (npentrel) wants to merge 1 commit intomainfrom
Naomi Pentrel (npentrel) wants to merge 1 commit intomainfrom
Conversation
…se linting to enforce terminology consistency.
github-actions
bot
added
ci
deepagents
Contributor
|
Mintlify preview ID generated: preview-opensw-1772800659-e3813c1 |
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
2 participants
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.
Description
The documentation inconsistently used "pre-built", "Pre-built", and "prebuilt" interchangeably. This PR standardizes on "prebuilt" (no hyphen) across all docs, and adds Vale prose linting to prevent regressions.
Terminology decision:
langgraph-prebuiltpackage name, 3.6× more common than "pre-built")Changes:
.vale.ini,.github/vale/styles/LangChain/Terminology.yml)make lint_prosetarget to Makefile for running Vale checks locally.mdxfiles as markdown and enforces the terminology substitution ruleResolves DOC-821
Test Plan
vale src/passes with 0 errors across 2180 filesmake testpasses (103 tests)pre-builtorPre-builtoccurrences insrc/