mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-26 13:36:13 +00:00
Jack Ye
b21fb2a4dc
The pages describing this code lived in lancedb/docs, a repository with ten stars that neither contributing guide mentioned. A user who hit a wrong page while reading the source had to find a separate, near-invisible repository to fix it. These 102 pages now sit beside the code, and a documentation fix is a pull request in the repository the reader already had open. `docs/web` is a complete Mintlify site: `cd docs/web && mint dev` serves it with no other checkout. Enterprise pages stay private and are merged in when the published site is assembled, so links into them do not resolve here — every open-source page does. `docs/web-tests` holds the tests the code examples are extracted from. They ran against a published wheel before; here they can run against this repository's own SDK, so an example that stops compiling fails the pull request that broke it rather than being noticed later. Both directories sit beside `docs/src` and are invisible to it: mkdocs reads `docs_dir: src`, so the SDK reference builds and deploys exactly as before.
36 lines
1.1 KiB
Markdown
36 lines
1.1 KiB
Markdown
# LanceDB documentation
|
|
|
|
The open-source pages of [docs.lancedb.com](https://docs.lancedb.com), beside the
|
|
code they describe.
|
|
|
|
## Preview locally
|
|
|
|
```bash
|
|
npm i -g mint # https://mintlify.com/docs/installation
|
|
cd docs/web && mint dev
|
|
```
|
|
|
|
That serves this directory on its own. Enterprise pages live in a private
|
|
repository and are merged in when the published site is assembled, so links to
|
|
`/enterprise/...` and the SQL and Geneva sections will not resolve here. Every
|
|
open-source page does.
|
|
|
|
## Code examples
|
|
|
|
Examples are not written into the pages. They live in real tests under
|
|
`docs/web-tests/{py,ts,rs}`, are extracted into `docs/web/snippets/`, and are
|
|
imported by the pages. Edit the test, then regenerate:
|
|
|
|
```bash
|
|
uv run docs/web-tests/mdx_snippets_gen.py -s docs/web-tests/py
|
|
```
|
|
|
|
An example that does not compile fails the pull request that broke it.
|
|
|
|
## Section anchors
|
|
|
|
Every heading carries an explicit `{#anchor}`. Those anchors are how the
|
|
Enterprise pages attach their additions to the right section, so they are
|
|
assigned once and not regenerated — leave an existing one alone even if the
|
|
heading it sits on is reworded.
|