Add VectorLint documentation set with Mintlify configuration#75
Merged
oshorefueled merged 4 commits intoTRocket-Labs:mainfrom Apr 23, 2026
Merged
Add VectorLint documentation set with Mintlify configuration#75oshorefueled merged 4 commits intoTRocket-Labs:mainfrom
oshorefueled merged 4 commits intoTRocket-Labs:mainfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
✅ Files skipped from review due to trivial changes (4)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdded a tracked project-wide style guide and a comprehensive set of new documentation pages under Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 10
🧹 Nitpick comments (3)
docs/introduction.mdx (1)
45-52: Consider clarifying the "PAT (Pay A Tax)" terminology.The acronym "PAT (Pay A Tax)" is introduced without explanation and doesn't appear in the codebase. If this is established terminology in the LLM evaluation space, consider adding a brief explanation or citation. If it's a coined term for this project, consider whether a more self-explanatory phrase would serve readers better.
💡 Example alternative phrasing
-VectorLint uses a PAT (Pay A Tax) evaluation pipeline to keep output precise: +VectorLint uses a two-stage evaluation pipeline to keep output precise:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/introduction.mdx` around lines 45 - 52, The "PAT (Pay A Tax)" acronym in the "How false positives are reduced" section is unclear and not in the codebase; either add one short explanatory sentence after the first mention (e.g., define PAT as the pipeline’s requirement that each candidate "pays" by providing required gate-check fields) or replace the acronym with a more descriptive phrase like "gate-check evaluation pipeline" and, if PAT is a coined term, add a parenthetical note that it is project-specific and a brief citation or link to further documentation (update the heading/first paragraph in the same section where "PAT (Pay A Tax)" appears).docs/llm-providers.mdx (1)
10-16: Add Amazon Bedrock to “Supported Providers” for parity with implementation.The runtime supports
amazon-bedrock, but it’s missing from the provider table. This makes the reference incomplete for users choosing Bedrock.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/llm-providers.mdx` around lines 10 - 16, Add a new table row for Amazon Bedrock in the providers table: set Provider to "Amazon Bedrock", `LLM_PROVIDER` value to `amazon-bedrock`, and the Key variable to the exact environment variable name used by the runtime implementation (search code for the Bedrock env var, e.g., names containing "BEDROCK" or "AMAZON_BEDROCK") and insert that exact identifier into the Key variable column so the docs match the implementation.docs/troubleshooting.mdx (1)
143-143: Consider more precise phrasing.The phrase "Very large context" could be strengthened by replacing the intensifier with more specific language, such as "Excessively large context" or "Context exceeding recommended limits."
✍️ Optional style improvement
-**Cause:** The file is too large to serve as reliable global context. Very large context degrades LLM precision and increases API costs. +**Cause:** The file is too large to serve as reliable global context. Excessively large context degrades LLM precision and increases API costs.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/troubleshooting.mdx` at line 143, Replace the vague intensifier "Very large context" in the "Cause:" sentence with a more precise phrase such as "Excessively large context" or "Context exceeding recommended limits"; locate the sentence containing the exact phrase "Very large context" and update it to the chosen wording so the guidance is clearer and more specific.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/cli-reference.mdx`:
- Line 87: The docs list an incorrect provider value: the LLM_PROVIDER
discriminator shown as "azure" is unsupported; update the documentation to use
"azure-openai" instead of "azure" where LLM_PROVIDER is described (search for
the LLM_PROVIDER entry in docs/cli-reference.mdx or the table row containing
`LLM_PROVIDER`) so users copy a valid provider identifier and provider selection
works as expected.
In `@docs/configuration.mdx`:
- Around line 6-13: Update the docs to accurately describe init behavior and
config.toml requiredness: change the statement that "Running `vectorlint init`
creates the first two automatically" to note that `vectorlint init` creates
VECTORLINT.md and .vectorlint.ini by default but `vectorlint init --quick` may
only scaffold minimal files, and clarify that a global
`~/.vectorlint/config.toml` is not strictly required—users can supply LLM API
keys via project-level environment variables or other project config, so reword
the table row for `config.toml` to indicate it is "Recommended for global API
keys" or "Optional if API keys are provided per-project" and add a short note
about alternative ways to provide provider credentials.
In `@docs/env-variables.mdx`:
- Around line 31-36: The docs incorrectly state that rules using the
technical-accuracy evaluator "return reduced-confidence results" when no search
provider is set; update the wording to reflect the actual behavior: if
`SEARCH_PROVIDER` (and required keys like `PERPLEXITY_API_KEY` for `perplexity`)
is not configured, the `technical-accuracy` evaluator currently raises a
missing-dependency error instead of degrading confidence. Edit the table rows
for `SEARCH_PROVIDER` and `PERPLEXITY_API_KEY` and the surrounding sentence to
mention that the evaluator will fail with a missing dependency error (and list
required provider values like `perplexity`) rather than returning
reduced-confidence results.
- Around line 83-87: The docs currently list precedence as Project `.env` →
Global `~/.vectorlint/config.toml` → System environment variables, which is
reversed; update the text to state that VectorLint resolves variables with
highest precedence first as: System environment variables (existing process.env)
→ Global `~/.vectorlint/config.toml` → Project `.env` file, and note that `.env`
and global config do not overwrite existing process.env values. Reference the
exact terms "Project `.env` file", "Global `~/.vectorlint/config.toml`", "System
environment variables", and "process.env" when making the change.
In `@docs/installation.mdx`:
- Around line 6-8: Update the "## Before you begin" paragraph to clarify Node.js
22 is in Maintenance LTS (security-only updates) and recommend using a currently
Active LTS with a longer support window (e.g., Node.js 24 or the latest Active
LTS); change the sentence that currently recommends "Node.js 22 LTS is
recommended" to explicitly note the maintenance status and suggest the Active
LTS alternative so readers know the difference and get a longer supported
release.
In `@docs/llm-providers.mdx`:
- Around line 10-16: Update the Azure provider entries so runtime config
matches: change the `LLM_PROVIDER` value from `azure` to `azure-openai` wherever
it appears (the provider table and the doc block around lines 72–80) and replace
the Azure env var `AZURE_OPENAI_API_KEY`/incorrect name with
`AZURE_OPENAI_DEPLOYMENT_NAME` (ensure both the "Key variable" column and any
explanatory text use `AZURE_OPENAI_DEPLOYMENT_NAME`), so the provider string and
env var names align with the runtime configuration.
In `@docs/presets.mdx`:
- Around line 53-59: The strictness override example uses the wrong preset rule
ID: it sets AIPatterns.strictness but the rule ID is AIPattern (singular);
update the example to target the correct rule ID by replacing
AIPatterns.strictness with AIPattern.strictness so the override applies to the
AIPattern rule ID.
In `@docs/quickstart.mdx`:
- Line 79: Replace the unresolved placeholder comment "{/* TBD: Add
representative terminal output here once confirmed — scored (1–10) or violations
list */}" with a concrete, final example of terminal output; remove the TODO
comment entirely and insert one of the suggested representative outputs (e.g., a
"No violations found" success block or an "✖ N violations found" block with a
short list of violations) so the published docs contain real sample output
instead of unfinished text.
In `@docs/use-cases.mdx`:
- Line 26: The documentation claims the technical-accuracy evaluator should
produce reduced-confidence results when no search provider is configured, but
the implementation currently throws a missing-dependency error; update the
technical-accuracy evaluator (e.g., the TechnicalAccuracyEvaluator class or
evaluateTechnicalAccuracy function) to detect absence of a search provider,
avoid throwing, and instead return a result object marked with reduced
confidence and an explanatory message indicating checks were skipped due to no
search provider; ensure any callers that expect thrown errors instead handle the
reduced-confidence response consistently.
In `@docs/VECTORLINT.md`:
- Around line 3-8: The header in VECTORLINT.md uses JSX-style comments `{/* ...
*/}`; update it to use HTML comments `<!-- ... -->` to match the project's
template and Markdown conventions — replace the `{/* ... */}` blocks in
VECTORLINT.md with `<!-- ... -->` and ensure the content and spacing remain
identical; also check the init-command.ts generated template (init-command.ts)
to confirm it already uses HTML comments and align any differences so both
sources use the same HTML comment format.
---
Nitpick comments:
In `@docs/introduction.mdx`:
- Around line 45-52: The "PAT (Pay A Tax)" acronym in the "How false positives
are reduced" section is unclear and not in the codebase; either add one short
explanatory sentence after the first mention (e.g., define PAT as the pipeline’s
requirement that each candidate "pays" by providing required gate-check fields)
or replace the acronym with a more descriptive phrase like "gate-check
evaluation pipeline" and, if PAT is a coined term, add a parenthetical note that
it is project-specific and a brief citation or link to further documentation
(update the heading/first paragraph in the same section where "PAT (Pay A Tax)"
appears).
In `@docs/llm-providers.mdx`:
- Around line 10-16: Add a new table row for Amazon Bedrock in the providers
table: set Provider to "Amazon Bedrock", `LLM_PROVIDER` value to
`amazon-bedrock`, and the Key variable to the exact environment variable name
used by the runtime implementation (search code for the Bedrock env var, e.g.,
names containing "BEDROCK" or "AMAZON_BEDROCK") and insert that exact identifier
into the Key variable column so the docs match the implementation.
In `@docs/troubleshooting.mdx`:
- Line 143: Replace the vague intensifier "Very large context" in the "Cause:"
sentence with a more precise phrase such as "Excessively large context" or
"Context exceeding recommended limits"; locate the sentence containing the exact
phrase "Very large context" and update it to the chosen wording so the guidance
is clearer and more specific.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: fc0953cc-02da-4285-9d7d-3205d0e44b14
⛔ Files ignored due to path filters (5)
docs/favicon.svgis excluded by!**/*.svgdocs/logo/dark.svgis excluded by!**/*.svgdocs/logo/light.svgis excluded by!**/*.svgdocs/logo/logo.svgis excluded by!**/*.svgdocs/logo/vectorlint.pngis excluded by!**/*.png
📒 Files selected for processing (27)
.gitignoredocs/VECTORLINT.mddocs/best-practices.mdxdocs/ci-integration.mdxdocs/cli-reference.mdxdocs/configuration-schema.mdxdocs/configuration.mdxdocs/customize-style-rules.mdxdocs/density-scoring.mdxdocs/docs.jsondocs/env-variables.mdxdocs/false-positive-tuning.mdxdocs/frontmatter-fields.mdxdocs/how-it-works.mdxdocs/initial-style-check.mdxdocs/installation.mdxdocs/introduction.mdxdocs/llm-providers.mdxdocs/presets.mdxdocs/project-config.mdxdocs/quality-scoring.mdxdocs/quickstart.mdxdocs/rubric-scoring.mdxdocs/style-guide.mdxdocs/team-rule-packs.mdxdocs/troubleshooting.mdxdocs/use-cases.mdx
💤 Files with no reviewable changes (1)
- .gitignore
…eshooting phrasing
Contributor
|
Thanks for this @taz-mon. Can we delete the Mintlify logo? I don't believe we need that. |
…s, and configuration-schema
- Move use-cases before how-it-works in Overview nav - Rewrite quickstart as true Golden Path with 4-step flow - Add LLM provider warning to quickstart and installation - Rewrite use-cases as task-oriented persona paths - Reframe how-it-works as architecture reference, not onboarding - Drop unexplained PAT acronym, preserve two-phase filtering structure
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.
Adds a complete /docs folder containing a Mintlify documentation site for VectorLint.
What's included
use-cases, configuration, project-config, llm-providers, style-guide,
customize-style-rules, presets, ci-integration, team-rule-packs,
false-positive-tuning, best-practices, cli-reference, env-variables,
troubleshooting, and more
Mintlify setup needed
To deploy from this repo, install the Mintlify GitHub app on
TRocket-Labs/vectorlint and set /docs as the monorepo path in
Git Settings at dashboard.mintlify.com.
Notes
docsandVECTORLINT.mdexclusionsSummary by CodeRabbit