Documentation should be clear, accurate, and consistently structured to provide maximum value to developers. Avoid overly broad or inaccurate statements that may mislead users, and prefer explanatory content over warnings when possible.
Key practices:
Example of improvement:
<!-- Instead of unclear or overly broad statements -->
For validation libraries we recommend using adapters...
<!-- Use more specific, accurate language -->
For some validation libraries like Zod v3, we recommend using adapters...
When documenting API properties, maintain consistent patterns:
### `defaultOnCatch` property
- Type: `(error: Error, errorInfo: ErrorInfo) => void`
- Optional
- Defaults to `routerOptions.defaultOnCatch`
- The default `onCatch` handler for errors caught by the Router ErrorBoundary
This approach ensures documentation serves as a reliable reference that developers can trust and easily understand.
Enter the URL of a public GitHub repository