Skip to content

Commit e27a6c1

Browse files
committed
updated docs
1 parent 8385091 commit e27a6c1

1 file changed

Lines changed: 14 additions & 15 deletions

File tree

docs/reference/overview.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,21 @@ This section is the formal API reference for `@datasketch/monkeytab`.
44

55
## Where to find what
66

7-
The full API documentation lives in three top-level files in the public repo:
7+
- **[API reference](/docs/reference/browser)**
8+
complete `<MonkeyTable>` props reference, every field type, every option,
9+
including the config-driven API and per-column coloring.
10+
- **[Extension API](/docs/reference/extending)**
11+
how to add custom renderers, editors, computed functions, and constraints.
12+
- **[Architecture](/docs/reference/architecture)**
13+
the high-level architecture of the package.
14+
- **[Changelog](/docs/changelog)**
15+
version history.
816

9-
- **[BROWSER.md](https://github.com/datasketch/monkeytab/blob/main/BROWSER.md)**
10-
complete `<MonkeyTable>` props reference, every field type, every option
11-
- **[EXTENDING.md](https://github.com/datasketch/monkeytab/blob/main/EXTENDING.md)**
12-
how to add custom renderers, editors, computed functions, and constraints
13-
- **[docs/architecture.md](https://github.com/datasketch/monkeytab/blob/main/docs/architecture.md)**
14-
the high-level architecture of the package
15-
16-
These files ship with the npm package and are also rendered here on the site
17-
(coming soon — we're wiring up the file mirror).
17+
Each page mirrors a file that ships with the npm package — `BROWSER.md`,
18+
`EXTENDING.md`, `architecture.md`, and `CHANGELOG.md` at the public repo
19+
root. The pages here render from a shared source, so every change on
20+
github is live here immediately.
1821

1922
## Quick links
2023

21-
- [Get started](/guides/getting-started)
22-
- [Field types](/guides/columns)
23-
- [Editing & shortcuts](/guides/editing)
24-
- [Sorting & pagination](/guides/sorting-pagination)
25-
- [Extending](/guides/extending)
24+
- [Get started](/docs/guides/getting-started)

0 commit comments

Comments
 (0)