Skip to content

Format markdown files & validate in CI - #153

Merged
davepeck merged 5 commits into
mainfrom
dave/format-readme
Aug 8, 2026
Merged

Format markdown files & validate in CI#153
davepeck merged 5 commits into
mainfrom
dave/format-readme

Conversation

@davepeck

@davepeck davepeck commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Including our README.md using the pre-existing just format_docs task.

Create a new just format_docs_check task. Also, check document formatting in CI.

@davepeck davepeck changed the title Format markdown files Format markdown files & validate in CI Aug 8, 2026
davepeck and others added 4 commits August 8, 2026 16:17
package.json asked for prettier ^3.9.5 but the lockfile still pinned
3.6.2, so `npm ci` refused to run at all. Regenerate it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Adds a format_docs_check recipe next to format_docs, wires it into the
default recipe, and runs the same check in CI. Prettier needs Node, so
CI now sets up Node 24 and installs from the lockfile rather than
letting npx pull an arbitrary version at run time.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The "**/*.md" glob picked up .pytest_cache/README.md. Prettier only
reads the root .gitignore, so anything hidden by a nested one -- which
is how pytest ignores its own cache -- was still getting checked. Name
the two paths we actually care about instead.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@davepeck
davepeck merged commit b8bc522 into main Aug 8, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant