Verifying Markdown and docs changes
Files: .md, .mdx, .rst, .txt. Derived from 61 scanned source repositories and 694 review prompts on https://awesomereviewers.com. Page: https://awesomereviewers.com/verify/docs/
How to use this: run every check under Run on every change. Then, for each section under Add when the change touches that describes your diff, run its checks too. Checks catch what a tool can find; then apply the listed review prompts for what tools miss (fetch each prompt’s raw URL).
Usage is the share of scanned repositories in this language that run the tool. A missing tool means no scanned repository runs one the scanner recognises: fall back to the prompts.
Run on every change
- Formatting:
prettier (44% of repos). Command seen: prettier --write .. Autofixes. Exit codes: 0 everything formatted; 1 something was not formatted (–check); 2 prettier error. Docs: https://prettier.io/docs/cli#exit-codes
- Linting — no tool detected in the sample. Catches: Bug-prone patterns, unused code and conventions the formatter does not cover.
- Type checking — no tool detected in the sample. Catches: Wrong types, unhandled null or None, call signatures broken across modules.
- Unit and integration tests — no tool detected in the sample. Catches: Behaviour regressions on the paths the tests exercise.
Review prompts (82 in total, most discussed first):
- Lint-Compliant Markdown Links — EbookFoundation/free-programming-books, Code Style
- Standardize PowerShell Naming — Azure/azure-powershell, Naming Conventions
- Consistent Snippet Style — freeCodeCamp/freeCodeCamp, Code Style
- Consistent Identifier Naming — freeCodeCamp/freeCodeCamp, Naming Conventions
- Documentation example consistency — prettier/prettier, Code Style
- Readable ES style — 30-seconds/30-seconds-of-code, Code Style
- Technical term consistency — fastapi/fastapi, Naming Conventions
- Consistent term capitalization — pydantic/pydantic, Naming Conventions
- Clear technical writing — vlang/v, Naming Conventions
- Use consistent terminology — nuxt/nuxt, Naming Conventions
- Markdown formatting consistency — ant-design/ant-design, Code Style
- Consistent descriptive naming conventions — helix-editor/helix, Naming Conventions
Add when the change touches
- Security scanning:
codeql (23% of repos). Runs via GitHub Action github/codeql-action/analyze. Alternatives: semgrep (8%). Docs: https://github.com/github/codeql
- Secret scanning:
gitleaks (3% of repos). Command seen: gitleaks git --config=.gitleaks.toml --baseline-path=.gitleaks-baseline.json --log-opts=$SCAN_REF --report-format=sarif --report-path=gitleaks.sarif .. Docs: https://github.com/gitleaks/gitleaks
- Dependency audit:
dependency-review (3% of repos). Runs via GitHub Action actions/dependency-review-action. Docs: https://github.com/actions/dependency-review-action
Review prompts (70 in total, most discussed first):
- Enforce scope boundaries — gravitational/teleport, Security
- Defense-in-depth Security Guardrails — QwenLM/qwen-code, Security
- Layer security defenses — rails/rails, Security
- Untrusted Actions Checkout — github/docs, Security
- Treat Inputs as Untrusted — bmad-code-org/bmad-method, Security
- Explicit Trust and Consent — nousresearch/hermes-agent, Security
- Secure examples correctness — apache/apisix, Security
- Validate security configurations — gofiber/fiber, Security
- Secure authentication flows — prowler-cloud/prowler, Security
- Secure Auth and Secrets — awslabs/mcp, Security
- Secret and Inert Safety — warpdotdev/warp, Security
- explicit security controls — argoproj/argo-cd, Security
Public APIs, signatures, error paths, nullability
- Type checking — no tool detected in the sample. Catches: Wrong types, unhandled null or None, call signatures broken across modules.
- Unit and integration tests — no tool detected in the sample. Catches: Behaviour regressions on the paths the tests exercise.
- Property-based tests — no tool detected in the sample. Catches: Edge-case inputs nobody wrote a test for; invariants over generated data.
Review prompts (87 in total, most discussed first):
- API authentication requirements — langflow-ai/langflow, API
- Use extensible parameter objects — electron/electron, API
- Idempotent error-safe disposers — nodejs/node, Error Handling
- Evolve return values — nodejs/node, API
- Document all responses — fastapi/fastapi, API
- Spec fidelity directives — Azure/azure-powershell, API
- Express error handling — freeCodeCamp/freeCodeCamp, Error Handling
- Precise API Contracts — tanstack/query, API
- API evolution strategy — ant-design/ant-design, API
- Design stable APIs — Azure/azure-sdk-for-net, API
- Error semantics invariants — QwenLM/qwen-code, Error Handling
- Typed API Contracts — QwenLM/qwen-code, API
Service and framework code
- Unit and integration tests — no tool detected in the sample. Catches: Behaviour regressions on the paths the tests exercise.
- Version and platform matrix:
ci-matrix (41% of repos). Command seen: analyze (language: 2). Docs: https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/run-job-variations
Review prompts (2 in total, most discussed first):
- Property-based tests — no tool detected in the sample. Catches: Edge-case inputs nobody wrote a test for; invariants over generated data.
- Fuzzing — no tool detected in the sample. Catches: Crashes, panics and hangs on malformed input, especially in parsers and decoders.
- Mutation testing — no tool detected in the sample. Catches: Tests that keep passing whatever the code does.
- Proofs and specifications:
coq (3% of repos). Docs: https://github.com/rocq-prover/rocq
Review prompts (28 in total, most discussed first):
- Precise type narrowing — astral-sh/ruff, Algorithms
- Algorithm explanation clarity — volcano-sh/volcano, Algorithms
- Specify algorithmic scope precisely — astral-sh/ty, Algorithms
- Correct Algorithm Contracts — 30-seconds/30-seconds-of-code, Algorithms
- Deterministic Matching Invariants — warpdotdev/warp, Algorithms
- Deterministic Array Algorithm Contracts — freeCodeCamp/freeCodeCamp, Algorithms
- special value handling — prometheus/prometheus, Algorithms
- Parallel branch traceability — elastic/elasticsearch, Algorithms
- Document algorithm behavior — vlang/v, Algorithms
- Consistent type algorithms — microsoft/typescript, Algorithms
- Deterministic Control-Plane Protocols — redis/redis, Algorithms
- Mathematical precision matters — tensorflow/swift, Algorithms
Threads, async code, locks, shared state
- Concurrency model checking — no tool detected in the sample. Catches: Races and orderings that fail only under specific interleavings.
- Undefined-behaviour detection — no tool detected in the sample. Catches: Memory-safety and aliasing violations in unsafe code.
- Property-based tests — no tool detected in the sample. Catches: Edge-case inputs nobody wrote a test for; invariants over generated data.
Review prompts (7 in total, most discussed first):
Network calls, retries, timeouts, protocols
- Unit and integration tests — no tool detected in the sample. Catches: Behaviour regressions on the paths the tests exercise.
- Fuzzing — no tool detected in the sample. Catches: Crashes, panics and hangs on malformed input, especially in parsers and decoders.
Review prompts (23 in total, most discussed first):
- Complete network configurations — traefik/traefik, Networking
- Middleware ordering and chaining — freeCodeCamp/freeCodeCamp, Networking
- Protocol-specific error handling — fastapi/fastapi, Networking
- Authenticated health checks — gravitational/teleport, Networking
- document network requirements — argoproj/argo-cd, Networking
- API endpoint documentation — langflow-ai/langflow, Networking
- Clear network API documentation — gofiber/fiber, Networking
- Specific network access documentation — kubeflow/kubeflow, Networking
- Control-plane connectivity rules — redis/redis, Networking
- Self-Contained Secure Networking — apache/apisix, Networking
- Multiple remote configuration — jj-vcs/jj, Networking
- Document network limitations — microsoft/playwright, Networking
UI components and pages
- End-to-end browser tests — no tool detected in the sample. Catches: User flows broken across components, routing and the network.
- Linting — no tool detected in the sample. Catches: Bug-prone patterns, unused code and conventions the formatter does not cover.
Review prompts (25 in total, most discussed first):
- documentation clarity standards — remix-run/react-router, React
- documentation formatting consistency — nuxt/nuxt, Next
- SSR documentation completeness — TanStack/router, Next
- Use reactive signal patterns — angular/angular, Angular
- Control focus and suspense — tanstack/query, React
- configuration compatibility validation — remix-run/react-router, Next
- Enhance code clarity — TanStack/router, React
- Valid Angular Examples — kamranahmedse/developer-roadmap, Angular
- React component API clarity — ant-design/ant-design, React
- Use Suspense Only When Ready — tanstack/query, Next
- Avoid reactive over-engineering — angular/angular, React
- Use slots for composition — mui/material-ui, React
Databases, migrations, caching
- Unit and integration tests — no tool detected in the sample. Catches: Behaviour regressions on the paths the tests exercise.
- Version and platform matrix:
ci-matrix (41% of repos). Command seen: analyze (language: 2). Docs: https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/run-job-variations
Review prompts (22 in total, most discussed first):
- Explicit StaleTime Policy — tanstack/query, Caching
- Prevent N+1 queries — django/django, Database
- Configure type serialization — elastic/elasticsearch, Database
- Understand query method behavior — rails/rails, Database
- Data model guardrails — awslabs/mcp, Database
- Cache invalidation rules — warpdotdev/warp, Caching
- Validate and Scope Cache — bmad-code-org/bmad-method, Caching
- Adaptive cache expiration strategy — neondatabase/neon, Caching
- Optimize cache sharing strategies — astral-sh/uv, Caching
- Cache performance preservation — neondatabase/neon, Database
- Document complete data flows — influxdata/influxdb, Database
- Use correct cache scope — github/docs, Caching
- No tool-based check applies; rely on the prompts.
Review prompts (22 in total, most discussed first):
- Explain optimization mechanisms — apache/mxnet, Performance Optimization
- Proactive cache warming — neondatabase/neon, Performance Optimization
- Leverage native tooling — vitejs/vite, Performance Optimization
- Strategic component loading — nuxt/nuxt, Performance Optimization
- Reduce runtime overhead — 30-seconds/30-seconds-of-code, Performance Optimization
- Resource-aware programming patterns — nodejs/node, Performance Optimization
- Stage intensive operations carefully — elastic/elasticsearch, Performance Optimization
- Document performance implications — rails/rails, Performance Optimization
- Optimize build configurations — facebook/yoga, Performance Optimization
- defer expensive operations — neovim/neovim, Performance Optimization
- Document performance tool lifecycle — kilo-org/kilocode, Performance Optimization
- Use direct path imports — mui/material-ui, Performance Optimization
Model, prompt and LLM code
- Unit and integration tests — no tool detected in the sample. Catches: Behaviour regressions on the paths the tests exercise.
Review prompts (29 in total, most discussed first):
- AI provider documentation completeness — BerriAI/litellm, AI
- Deterministic Prompt Contracts — bmad-code-org/bmad-method, AI
- Technical precision matters — apache/mxnet, AI
- AI configuration documentation — stanfordnlp/dspy, AI
- Accurate AI Content — kamranahmedse/developer-roadmap, AI
- AI documentation clarity — angular/angular, AI
- AI terminology consistency — block/goose, AI
- AI response variability — langflow-ai/langflow, AI
- Document AI model capabilities — vllm-project/vllm, AI
- Document AI infrastructure requirements — menloresearch/jan, AI
- Document AI APIs completely — deeplearning4j/deeplearning4j, AI
- Document AI limitations — sgl-project/sglang, AI
Logging, metrics, tracing
- No tool-based check applies; rely on the prompts.
Review prompts (19 in total, most discussed first):
- complete observability router options — traefik/traefik, Observability
- Complete observability documentation — prometheus/prometheus, Observability
- Place attributes correctly — open-telemetry/opentelemetry-python, Observability
- Tracing schema and continuity — awslabs/agentcore-samples, Observability
- Prefer lightweight observability integrations — BerriAI/litellm, Observability
- Use appropriate metric types — nodejs/node, Observability
- Environment-specific logger configuration — rails/rails, Logging
- Validated Observability Guidance — awslabs/mcp, Observability
- Trace semconv and completeness — apache/apisix, Observability
- Design comprehensive metrics — gravitational/teleport, Observability
- Document observability prerequisites — argoproj/argo-cd, Observability
- Use higher-level telemetry — Azure/azure-sdk-for-net, Observability
CI workflows and configuration files
- CI workflow linting — no tool detected in the sample. Catches: Broken GitHub Actions syntax, script injection, over-broad token permissions.
- File hygiene:
pre-commit-hooks (13% of repos). Runs via pre-commit hook end-of-file-fixer. Autofixes. Docs: https://github.com/pre-commit/pre-commit-hooks
Review prompts (147 in total, most discussed first):
- configuration value consistency — traefik/traefik, Configurations
- Configuration documentation clarity — langflow-ai/langflow, Configurations
- Follow support tiers — Homebrew/brew, Configurations
- Config source alignment — nousresearch/hermes-agent, Configurations
- Config Documentation Constraints — infiniflow/ragflow, Configurations
- Configuration documentation clarity — astral-sh/ty, Configurations
- thoughtful configuration design — gravitational/teleport, Configurations
- explicit configuration specification — python-poetry/poetry, Configurations
- Pin CI Actions By SHA — github/docs, CI/CD
- Explicit dependency constraints — celery/celery, Configurations
- Changeset release hygiene — mermaid-js/mermaid, CI/CD
- Isolate configuration concerns — fastapi/fastapi, Configurations
Dependencies and lockfiles
- Dependency audit:
dependency-review (3% of repos). Runs via GitHub Action actions/dependency-review-action. Docs: https://github.com/actions/dependency-review-action
- Lockfile consistency — no tool detected in the sample. Catches: A lockfile that no longer matches its manifest.
- Version and platform matrix:
ci-matrix (41% of repos). Command seen: analyze (language: 2). Docs: https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/run-job-variations
The tests themselves
- Mutation testing — no tool detected in the sample. Catches: Tests that keep passing whatever the code does.
- Version and platform matrix:
ci-matrix (41% of repos). Command seen: analyze (language: 2). Docs: https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/run-job-variations
Review prompts (12 in total, most discussed first):
- Sync versus async tests — fastapi/fastapi, Testing
- Evidence-grade Testing — QwenLM/qwen-code, Testing
- prefer testing libraries — sveltejs/svelte, Testing
- testing best practices — microsoft/playwright, Testing
- Clarify testing documentation — cypress-io/cypress, Testing
- document test tool options — prometheus/prometheus, Testing
- Enforce coverage thresholds — avelino/awesome-go, Testing
- Comprehensive Test Coverage — mermaid-js/mermaid, Testing
- Implement simulation testing — volcano-sh/volcano, Testing
- Verify test commands — vercel/turborepo, Testing
- Use TypeScript-specific tests — microsoft/typescript, Testing
- Add comprehensive test coverage — stanfordnlp/dspy, Testing
- Docs build:
mkdocs (13% of repos). Command seen: mkdocs build. Alternatives: sphinx (2%). Docs: https://github.com/mkdocs/mkdocs
- Spelling:
codespell (8% of repos). Command seen: codespell. Docs: https://github.com/codespell-project/codespell
Review prompts (119 in total, most discussed first):
- Canonical Documentation Entries — EbookFoundation/free-programming-books, Documentation
- Changelog entry conventions — can1357/oh-my-pi, Documentation
- Doc accuracy and conformance — nousresearch/hermes-agent, Documentation
- Docs Match Implementation — apache/apisix, Documentation
- realistic documentation examples — sveltejs/svelte, Documentation
- Provide contextual explanations — electron/electron, Documentation
- Verify documentation against behavior — promptfoo/promptfoo, Documentation
- Organize documentation content — langflow-ai/langflow, Documentation
- precise language usage — nuxt/nuxt, Documentation
- Documentation clarity rules — freeCodeCamp/freeCodeCamp, Documentation
- Define technical terms clearly — jj-vcs/jj, Documentation
- Document behavior clearly — 30-seconds/30-seconds-of-code, Documentation
Source repositories
freeCodeCamp/freeCodeCamp, EbookFoundation/free-programming-books, kamranahmedse/developer-roadmap, ossu/computer-science, avelino/awesome-go, iptv-org/iptv, 30-seconds/30-seconds-of-code, electron/electron, nodejs/node, langflow-ai/langflow, angular/angular, mui/material-ui, ant-design/ant-design, neovim/neovim, fastapi/fastapi, django/django, sveltejs/svelte, microsoft/playwright, vitejs/vite, elastic/elasticsearch, astral-sh/uv, prometheus/prometheus, nuxt/nuxt, rails/rails, warpdotdev/warp, traefik/traefik, bmad-code-org/bmad-method, prettier/prettier, tanstack/query, serverless/serverless, colinhacks/zod, astral-sh/ruff, helix-editor/helix, logseq/logseq, gofiber/fiber, vlang/v, vadimdemedes/ink, BerriAI/litellm, vercel-labs/agent-skills, opentofu/opentofu, anthropics/claude-code, pydantic/pydantic, QwenLM/Qwen3, Tencent/ncnn, jj-vcs/jj, github/docs, argoproj/argo-cd, apache/apisix, SWE-agent/SWE-agent, astral-sh/ty, TanStack/router, awslabs/mcp, tensorflow/swift, Azure/azure-sdk-for-net, volcano-sh/volcano, Azure/azure-powershell, awslabs/aidlc-workflows, google-gemini/gemini-skills, cloudflare/workers-sdk, open-telemetry/opentelemetry-python, getsentry/sentry-php