Repository navigation
build(website): bump Biome to 2.6.4 and markdownlint-cli2 to 0.24 - #112
Conversation
Biome 2.6 formats Markdown by default, so turn on its frontmatter parser and format the docs. The parser is off by default, which makes Biome read frontmatter as Markdown: it rewrites a one-key block to a heading, which breaks the docs build, and adds a blank line inside the rest. Biome handles layout and markdownlint-cli2 handles structure. Biome reports none of the skipped headings, bare URLs or missing alt text markdownlint does.
Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
|
| "@types/react": "^19.3.0", | ||
| "cross-env": "^10.1.0", | ||
| "markdownlint-cli2": "^0.23.2", | ||
| "markdownlint-cli2": "^0.24.0", |
There was a problem hiding this comment.
Suggestion: This adds a Node 22-only CLI while the website still declares Node 20 support, so Node 20 users cannot run make lint-docs reliably.
Assessment: 🟠 Major · 🔁 Occurrence: Sometimes · 🏷️ Api mismatch
Prompt for AI Agent 🤖
This is a comment left during a code review.
**Path:** website/package.json
**Line:** 40:40
**Comment:**
*Api Mismatch: This adds a Node 22-only CLI while the website still declares Node 20 support, so Node 20 users cannot run `make lint-docs` reliably.
Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.
Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix
User description
Biome 2.6 formats Markdown by default, so turn on its frontmatter parser and format the docs. The parser is off by default, which makes Biome read frontmatter as Markdown: it rewrites a one-key block to a heading, which breaks the docs build, and adds a blank line inside the rest.
Biome handles layout and markdownlint-cli2 handles structure. Biome reports none of the skipped headings, bare URLs or missing alt text markdownlint does.
Summary
What does this PR change, and why?
Closes #
Type of change
Checklist
make cipasses (fmt-check, vet, lint, vuln, test-race, lint-docs) across all moduleswebsite/docs/with a version marker for anything new (_0.3+_,_Added in 0.3._,// 0.3+) — neverwebsite/versioned_docs/AGENTS.md/.sqlguard.example.ymlif a convention or config key changed## [Unreleased]inCHANGELOG.mdanalyzer/middleware/reporterResult)Notes for reviewers
Anything reviewers should focus on — tricky areas, trade-offs, follow-ups.
CodeAnt-AI Description
Keep website docs buildable with updated Markdown formatting tools
What Changed
Impact
✅ Frontmatter survives Markdown formatting✅ Website documentation builds after formatting✅ Markdown checks still flag bare URLs and missing image alt text💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
Preserve Org Learnings with CodeAnt
You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
Check Your Repository Health
To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.