Ensure that all API documentation, including code examples and integration guides, accurately reflects the current API state. When API changes occur (such as import/export modifications, new entry points, or version compatibility updates), corresponding documentation must be updated immediately to prevent developer confusion and integration errors.
Ensure that all API documentation, including code examples and integration guides, accurately reflects the current API state. When API changes occur (such as import/export modifications, new entry points, or version compatibility updates), corresponding documentation must be updated immediately to prevent developer confusion and integration errors.
Key areas to verify:
Example of outdated documentation that needs correction:
// Outdated - no longer works
import Parser from 'web-tree-sitter';
// Current - matches actual API
import { Parser } from 'web-tree-sitter';
// Also document available variants
import { Parser } from 'web-tree-sitter/debug';
This practice prevents developers from encountering runtime errors due to mismatched documentation and ensures smooth API adoption.
Enter the URL of a public GitHub repository