Maintenance Guide ​

This document is for repository maintainers and code contributors. If you only want to submit or revise public site content, see the Contribution Guide.

Primary Directories ​

• docs/: the VitePress site and online tool pages
• packages/compat-finder/: the compatibility troubleshooting library and CLI

Development Environment ​

Install Dependencies ​

Install Node.js and pnpm first, then run this in the repository root:

pnpm install

Common Commands ​

Docs Site ​

• Start the docs development server with hot reload: pnpm docs:watch
• Build the docs site: pnpm docs:build
• Build the docs site and start the preview server: pnpm docs:preview

compat-finder Package ​

• Run the CLI directly: pnpm compat-finder:cli
• Build the package: pnpm compat-finder:build
• Start watch mode: pnpm compat-finder:watch
• Run package tests: pnpm compat-finder:test

Local Checks ​

• Format files: pnpm fmt
• Run linting and type checks: pnpm lint
• Run all tests: pnpm test

Changesets ​

• Create a release note entry: pnpm changeset
• Add a changeset when a change affects any published workspace package; do not add one for docs-only changes, public content edits, or internal cleanup that does not affect published package behavior
• Follow the prompt to select the affected published package and the appropriate semver bump: patch, minor, or major
• Commit the generated .changeset/*.md file together with the code changes

CI Checks ​

Repository-wide Checks ​

nodejs-ci.yml runs on pull requests and pushes to main. It mainly covers:

• pnpm fmt
• pnpm lint
• pnpm test

Formatting and some auto-fix steps may commit corrections back to the PR automatically.

PR Build Checks ​

• pr-docs-build.yml: verifies that the docs site builds successfully
• pr-compat-finder-build.yml: verifies that the compat-finder package builds successfully

Related Documentation ​

If you are editing public content pages or tool documentation, also refer to:

• the Contribution Guide
• the README.md file in the relevant directory when available

Release Guide ​

See the Release Guide for release flow, versioning rules, and release PR behavior.