chore(markdown-lint): setup markdownlint to lint md files and avoid having errors#1072
Open
gabrielseco wants to merge 9 commits into
Open
chore(markdown-lint): setup markdownlint to lint md files and avoid having errors#1072gabrielseco wants to merge 9 commits into
gabrielseco wants to merge 9 commits into
Conversation
Contributor
📦 Bundle Size Report
Size Limits
Largest Files (Top 5)
View All Files (317 total)
✅ Bundle size check passed |
Contributor
📊 Coverage Report⚪ Coverage unchanged
Detailed BreakdownLines Coverage
Statements Coverage
Functions Coverage
Branches Coverage
✅ Coverage check passed |
Contributor
|
Deploy preview for remote-flows ready!
Deployed with vercel-action |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit ff86492. Configure here.
remotecom
changed the title
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
1 participant
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.
Add markdownlint to avoid having errors in changelogs mostly me :)
Note
Low Risk
Documentation and dev-tooling only; no runtime or application logic changes.
Overview
This PR adds markdownlint as a first-class check for repo documentation, wired into local scripts, CI, and editor setup.
Tooling:
markdownlint-cliis added as a dev dependency withlint:md/lint:md:fixscripts and inclusion in thecinpm script. Configuration lives in.markdownlint.json(defaults on, with several rules turned off for CHANGELOG-style docs) and.markdownlintignorefor build/output paths.CI: PR and main workflows run
npm run lint:mdin the lint-and-format job after JS lint.Developer experience: VS Code recommends the markdownlint extension and enables markdownlint (and ESLint) fix-on-save;
DEVELOPMENT.mddocuments commands, rule choices, and CI behavior.Doc touch-ups: A few markdown files are adjusted to satisfy the new linter (e.g. heading spacing in
CHANGELOG.md, blank lines around fenced blocks, table formatting in schema docs).Reviewed by Cursor Bugbot for commit 645f18a. Bugbot is set up for automated code reviews on this repo. Configure here.