Skip to content

docs: tighten two lines from the #2 review - #50

Merged
adrianbrowning merged 1 commit into
mainfrom
docs/2-review-followup
Oct 6, 2026
Merged

adrianbrowning merged 1 commit into
mainfrom
docs/2-review-followup

Conversation

@adrianbrowning

Copy link
Copy Markdown
Owner

Follow-up to #49, which merged before this commit was pushed.

Summary

 README.md (quick start)
-CI runs the same two steps in the same order, with `--check` instead of `--apply`:
+In CI, run the same two steps in the same order, with `--check` instead of `--apply`:
 packages/mdcode/README.md (mdcode and Snippet Checkers)
-mdcode can also run your own type checker over blocks written in the Markdown. [`validate-snippets.mjs`] extracts ...
+For blocks written in the Markdown, the ready-to-copy [`validate-snippets.mjs`] script can run your own type checker. It extracts ... with `mdcode extract` ...

The first line was worded as a fact about CI. It's a recommendation. The second gives the credit to the copyable script: mdcode itself only extracts the blocks, and the script runs the checker (Validating Runnable Snippets in CI, step 2).

Evidence

The pre-push pnpm check passes.

Merge Danger

Door: two-way

Blast Radius: docs

@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown

bumpy-frog

This PR changes 1 package but has no bump file, so this check is failing.

Changed package(s) without a bump file:

  • mdcode-ts

If these changes should be released, add a bump file describing the version bump. If no release is needed (e.g. a dependency-only or dev-only change), add an empty bump file to acknowledge that intent — that satisfies this check without bumping any package.

pnpm exec bumpy add            # describe a release
pnpm exec bumpy add --empty    # acknowledge no release is needed

Or directly on GitHub: add a bump file · add an empty bump file.


This comment is maintained by bumpy.

@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown

⚠️ ESLint Check Warnings

Click to see details

Style


> mdcode@0.0.1 lint:s /home/runner/work/mdcode-ts/mdcode-ts
> pnpm -r lint:s

Scope: 2 of 3 workspace projects
packages/mdcode lint:s$ eslint --config .eslintrc.style.json "src/**/*.{j,t}s{,x}" --cache --max-warnings=0
packages/mdcode lint:s: [baseline-browser-mapping] The data in this module is over two months old.  To ensure accurate Baseline data, please update: 'npm i baseline-browser-mapping@latest -D'
packages/mdcode lint:s: Done
packages/usage lint:s$ eslint --config .eslintrc.style.json "{tests,fixtures,examples}/**/*.{j,t}s{,x}" --cache --max-warnings=0
packages/usage lint:s: [baseline-browser-mapping] The data in this module is over two months old.  To ensure accurate Baseline data, please update: 'npm i baseline-browser-mapping@latest -D'
packages/usage lint:s: Done

Correctness


> mdcode@0.0.1 lint:esl /home/runner/work/mdcode-ts/mdcode-ts
> pnpm -r lint:esl

Scope: 2 of 3 workspace projects
packages/mdcode lint:esl$ eslint "src/**/*.{j,t}s{,x}" --cache --max-warnings=0
packages/mdcode lint:esl: [baseline-browser-mapping] The data in this module is over two months old.  To ensure accurate Baseline data, please update: 'npm i baseline-browser-mapping@latest -D'
packages/mdcode lint:esl: Done
packages/usage lint:esl$ eslint "{tests,fixtures,examples}/**/*.{j,t}s{,x}" --cache --max-warnings=0
packages/usage lint:esl: [baseline-browser-mapping] The data in this module is over two months old.  To ensure accurate Baseline data, please update: 'npm i baseline-browser-mapping@latest -D'
packages/usage lint:esl: Done

View workflow run

@adrianbrowning
adrianbrowning merged commit aa02ed8 into main Oct 6, 2026
4 of 5 checks passed
@adrianbrowning
adrianbrowning deleted the docs/2-review-followup branch October 6, 2026 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant