Repository navigation

Generate the README API reference from JSDoc - #4224

Open

amanmahajan7 wants to merge 34 commits into

mainfrom

typedoc-readme-api

Open

Generate the README API reference from JSDoc#4224
amanmahajan7 wants to merge 34 commits into
mainfrom
typedoc-readme-api

Commits on Oct 22, 2026
- Generate the README API reference from JSDoc
  
  amanmahajan7
  and
  claude
  committed
  acef00f
- Lint JSDoc comments with oxlint
  
  amanmahajan7
  and
  claude
  committed
  461e738
- Simplify the generated API reference
  
  amanmahajan7
  and
  claude
  committed
  5529a78
- Rename the `TRow` and `TSummaryRow` type parameters to `R` and `SR`
  
  amanmahajan7
  and
  claude
  committed
  e7384dc
- Don't repeat members inherited through internal types
  
  amanmahajan7
  and
  claude
  committed
  64cc553
- Name destructured parameters `props` in the API reference
  
  amanmahajan7
  and
  claude
  committed
  1b861ea
- Show components as JSX elements in the API reference
  
  amanmahajan7
  and
  claude
  committed
  17dbe0d
- Use TypeScript 6 for TypeDoc as recommended by the TypeScript team
  
  amanmahajan7
  and
  claude
  committed
  4baada5
- Generate the API reference from `lib/index.d.ts` instead of TypeDoc
  
  amanmahajan7
  and
  claude
  committed
  ff50840
- Match the layout and order of the previous README
  
  amanmahajan7
  and
  claude
  committed
  19848bd
- Use name-only headings in the API reference
  
  amanmahajan7
  and
  claude
  committed
  bb3ba0b
- Merge internal base interfaces into the public interfaces in the API reference
  
  amanmahajan7
  and
  claude
  committed
  ca8ae8e
- Fail the API reference generation on unresolved links, unsupported tags, and headings in JSDoc
  
  amanmahajan7
  and
  claude
  committed
  c436614
- Merge branch 'main' into typedoc-readme-api
  amanmahajan7
  authored
  c18d42a
- Merge remote-tracking branch 'origin/typedoc-readme-api' into typedoc-readme-api
  amanmahajan7
  committed
  91084a8
Commits on Oct 23, 2026
- Generate the API reference with the TypeScript 7 API instead of oxc-parser
  
  amanmahajan7
  and
  claude
  committed
  331e384
- Merge branch 'main' into typedoc-readme-api
  amanmahajan7
  committed
  c60a5ce
- Set the sections of the API reference in `src/index.ts` instead of `@group` tags
  
  amanmahajan7
  and
  claude
  committed
  0a42091
- Fail the API reference generation instead of dropping content in more cases
  
  amanmahajan7
  and
  claude
  committed
  c07cfbf
- Merge branch 'main' into typedoc-readme-api
  amanmahajan7
  committed
  35bdd31
- Merge branch 'main' into typedoc-readme-api
  amanmahajan7
  authored
  59bbf64
Commits on Oct 25, 2026
- Merge branch 'main' into typedoc-readme-api
  amanmahajan7
  committed
  8422009
- Merge branch 'main' into typedoc-readme-api
  amanmahajan7
  committed
  f8b1805
Commits on Oct 26, 2026
- Merge branch 'main' into typedoc-readme-api
  amanmahajan7
  authored
  906cb34
Commits on Oct 27, 2026
- Merge branch 'main' into typedoc-readme-api
  amanmahajan7
  committed
  38e34e0
- Merge branch 'main' into typedoc-readme-api
  amanmahajan7
  authored
  72665b4
- Merge branch 'main' into typedoc-readme-api
  amanmahajan7
  authored
  dbaf9c2
Commits on Oct 28, 2026
- Address review comments on the API docs
  
  amanmahajan7
  and
  claude
  committed
  31d6b14
- Link the member mentions in the API docs
  
  amanmahajan7
  and
  claude
  committed
  2639da5
Commits on Oct 30, 2026
- Merge branch 'main' into typedoc-readme-api
  
  amanmahajan7
  and
  claude
  committed
  1416d64
Commits on Nov 2, 2026
- Merge branch 'main' into typedoc-readme-api
  
  amanmahajan7
  and
  claude
  committed
  9d4fa04
- Use JSDoc tags for the examples, return values, defaults, and related types
  
  amanmahajan7
  and
  claude
  committed
  00a8f2a
- Make `RenderCheckboxProps.checked` required, and `SelectCheckboxProps` an alias of `RenderCheckboxProps`
  
  amanmahajan7
  and
  claude
  committed
  1f1e05c
Commits on Nov 3, 2026
- Merge branch 'main' into typedoc-readme-api
  amanmahajan7
  authored
  f2a070d

Commits

Commits on Oct 22, 2026

Commits on Oct 23, 2026

Commits on Oct 25, 2026

Commits on Oct 26, 2026

Commits on Oct 27, 2026

Commits on Oct 28, 2026

Commits on Oct 30, 2026

Commits on Nov 2, 2026

Commits on Nov 3, 2026