Back to all reviewers

Ensure documentation accuracy

vitejs/vite
Based on 6 comments
Markdown

Documentation must precisely reflect the current codebase implementation. When documenting features, options, or APIs: 1. Validate that all examples match the actual implementation. For instance, if template names or file formats change, update all references in the documentation:

Documentation Markdown

Reviewer Prompt

Documentation must precisely reflect the current codebase implementation. When documenting features, options, or APIs:

  1. Validate that all examples match the actual implementation. For instance, if template names or file formats change, update all references in the documentation:
- Package manager lockfile content, e.g. `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml` or `bun.lockb`.
+ Package manager lockfile content, e.g. `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `bun.lock`, or `bun.lockb`.
  1. Remove outdated conditional language when options change. Instead of “can also be”, use definitive statements that reflect current functionality:
- The value can also be an [options object] passed to `https.createServer()`.
+ The value is an [options object] passed to `https.createServer()`.
  1. Remove deprecated parameters from examples and clarify their status in API references:
 interface ModuleRunnerOptions {
   /**
    * Root of the project
+   * @deprecated not used anymore and to be removed
    */
-  root: string
+  root?: string
 }
  1. When updating or renaming APIs, ensure all documentation consistently uses the new terminology throughout. Maintaining accuracy builds user trust and prevents confusion when implementing features.
6
Comments Analyzed
Markdown
Primary Language
Documentation
Category

Source Discussions