Commit 04215ac
authored
feat: generate API reference docs with typedoc (#270)
auto generate markdown API reference docs from JSDoc comments using
typedoc to have an embedded docs inside node_modules. This allows AI
agent skills to point to `node_modules/axiom/dist/docs/ ` for a version
matched API reference
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> **Low Risk**
> Low risk: this only changes the build pipeline and dev dependencies to
generate packaged docs, without touching runtime/library logic.
>
> **Overview**
> **Adds auto-generated API reference docs to the `axiom` package
build.** The `packages/ai` `build` script now runs `typedoc` to emit
markdown docs into `dist/docs`.
>
> Introduces `typedoc.json` to define the public entry points to
document and configures markdown output (no readme, excludes
private/internal/external symbols). Adds `typedoc` +
`typedoc-plugin-markdown` dev dependencies and updates `pnpm-lock.yaml`
accordingly.
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
1772b5a. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->1 parent 56bd7bf commit 04215ac
3 files changed
+193
-23
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| |||
126 | 126 | | |
127 | 127 | | |
128 | 128 | | |
| 129 | + | |
| 130 | + | |
129 | 131 | | |
130 | 132 | | |
131 | 133 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
0 commit comments