feat: typedoc

[fmorency]

This pull request adds automated API documentation generation using TypeDoc and improves the visibility and accessibility of type exports from the main entry point. The most important changes are grouped below:

API Documentation Generation:

• Added a docs script to package.json that runs TypeDoc to generate API documentation.
• Added typedoc as a development dependency in package.json.
• Introduced a new typedoc.json configuration file to customize TypeDoc output and documentation settings.
• Updated README.md and CLAUDE.md to document the new npm run docs command and explain how to view the generated documentation. [1] [2]

Type Exports:

• Updated src/index.ts to re-export ValidationResult and RetryOptions types, making them accessible from the package's main entry point.

[Copilot]

Pull request overview

This PR adds automated API documentation via TypeDoc and surfaces key configuration and retry types from the main package entrypoint to improve DX.

Changes:

• Introduced a typedoc.json configuration and a docs npm script to generate API reference documentation into a docs/ folder.
• Added typedoc as a dev dependency and updated .gitignore to exclude generated docs from version control.
• Updated src/index.ts to re-export ValidationResult and RetryOptions so consumers can import these types directly from the package root, and updated README.md/CLAUDE.md with usage instructions.

Reviewed changes

Copilot reviewed 5 out of 7 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
typedoc.json	Adds TypeDoc configuration targeting src/index.ts, outputting HTML docs to ./docs with project metadata and GitHub navigation link.
src/index.ts	Extends root exports to include ValidationResult from config and RetryOptions from retry, making these types available from the main entrypoint without changing runtime behavior.
package.json	Adds a docs npm script that runs typedoc and registers typedoc@^0.28.16 as a dev dependency, enabling local doc generation.
package-lock.json	Locks the dependency graph for typedoc and its transitive dependencies to ensure reproducible documentation builds.
README.md	Documents the new npm run docs command and explains where generated documentation is written and how to view it.
CLAUDE.md	Mirrors the new npm run docs workflow in the contributor-/automation-focused documentation.
.gitignore	Excludes the generated docs/ directory from version control to keep the repository clean from build artifacts.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.