docs: overhaul README.md, CLAUDE.md and add CONTRIBUTING.md#234
Merged
branchseer merged 4 commits intomainfrom Mar 13, 2026
Merged
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
cpojer
approved these changes
Mar 12, 2026
The `paths-ignore: '**/*.md'` filter prevented CI from running on docs-only PRs, leaving required checks (`Format and Check Deps`, `done`) unreported and blocking merge. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add `detect-changes` job with `dorny/paths-filter` to skip the expensive 4-platform test matrix on docs-only PRs while ensuring `Format and Check Deps` and `done` always run and report. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
branchseer
deleted the
03-13-docs_overhaul_readme.md_claude.md_and_add_contributing.md
branch
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.
Summary
README.md— concise project description, getting started withvp runexamples, link to Vite+ docsCLAUDE.md— repository structure, architecture, code constraints, streamlined for AI-assisted developmentCONTRIBUTING.md— prerequisites,vtvsvpcomparison, dev workflow, testing, cross-platform requirements, code conventions