{"id":28177899,"url":"https://github.com/lancedb/documentation","last_synced_at":"2026-03-03T11:39:13.531Z","repository":{"id":293500466,"uuid":"984021637","full_name":"lancedb/documentation","owner":"lancedb","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-15T18:08:36.000Z","size":6594,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-16T01:11:28.404Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lancedb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-15T09:20:00.000Z","updated_at":"2025-05-15T18:16:27.000Z","dependencies_parsed_at":"2025-05-16T01:11:32.813Z","dependency_job_id":null,"html_url":"https://github.com/lancedb/documentation","commit_stats":null,"previous_names":["davidmyriel/documentation","lancedb/documentation"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lancedb%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lancedb%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lancedb%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lancedb%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lancedb","download_url":"https://codeload.github.com/lancedb/documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254448596,"owners_count":22072765,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-16T01:11:09.723Z","updated_at":"2026-03-03T11:39:13.519Z","avatar_url":"https://github.com/lancedb.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LanceDB Documentation\n\nThis repository contains the documentation for [LanceDB](https://github.com/lancedb/lancedb), a vector database for AI applications. The documentation is built using MkDocs and deployed to [lancedb.github.io/documentation](https://lancedb.github.io/documentation/).\n\n## Building the Documentation Site\n\n### Prerequisites\n\n- Python 3.8 or higher\n- Node.js and npm (for TypeScript examples)\n- LanceDB Python package installed\n\n### Setup\n\n1. **Install LanceDB Python**:\n   ```bash\n   # From the LanceDB repository root\n   cd python\n   make develop\n   ```\n\n2. **Install documentation dependencies**:\n   ```bash\n   pip install -r docs/requirements.txt\n   ```\n\n### Building and Previewing\n\nTo preview the documentation locally with live reloading:\n\n```bash\ncd docs\nmkdocs serve\n```\n\nThe documentation will be available at [http://127.0.0.1:8000/](http://127.0.0.1:8000/).\n\nTo generate static HTML files:\n\n```bash\nPYTHONPATH=. mkdocs build -f docs/mkdocs.yml\n```\n\nThis will create a `docs/site` directory with the built documentation, which you can open in a browser to verify locally.\n\n## Contributing to LanceDB Documentation\n\n### General Guidelines\n\n1. **Clear and Concise**: Write documentation that is easy to understand.\n2. **Examples**: Include practical examples where appropriate.\n3. **Consistency**: Follow the existing documentation style and structure.\n4. **Correctness**: Ensure all examples are tested and work correctly.\n\n### Directory Structure\n\n- `docs/src/` - Source markdown files for the documentation\n- `docs/overrides/` - Custom template overrides for MkDocs\n- `docs/test/` - Documentation tests\n\n### Adding or Updating Documentation\n\n1. Create or modify markdown files in the appropriate directory under `docs/src/`.\n2. Add code examples in the relevant test directories to ensure they are verified by tests.\n3. Preview your changes locally using `mkdocs serve`.\n4. Submit a pull request with your changes.\n\n### Testing Examples\n\nExamples in the documentation are maintained as executable test files to ensure they remain correct.\n\n#### Python Examples\n\nPython examples are located in `python/python/tests/docs/`:\n\n```bash\ncd python\npytest -vv python/tests/docs\n```\n\n#### TypeScript Examples\n\nTypeScript examples are in `nodejs/examples/`:\n\n1. Build the LanceDB TypeScript package:\n   ```bash\n   cd nodejs\n   npm ci\n   npm run build\n   ```\n\n2. Run the examples:\n   ```bash\n   cd nodejs/examples\n   npm ci\n   npm test\n   ```\n\n### API Documentation\n\n#### Python API\n\nPython API documentation is organized based on `docs/src/python/python.md`. When adding new types or functions, they must be manually added to this file to appear in the reference documentation.\n\n#### TypeScript API\n\nTypeScript API documentation is generated using [typedoc](https://typedoc.org/). After adding new APIs, regenerate the documentation:\n\n```bash\ncd nodejs\nnpm run docs\n```\n\nThe generated files should be committed to the repository.\n\n## Deployment\n\nThe documentation is automatically built and deployed by GitHub Actions whenever a commit is pushed to the `main` branch. This means the documentation may include unreleased features.\n\n## License\n\nThe documentation is licensed under the same license as LanceDB.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flancedb%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flancedb%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flancedb%2Fdocumentation/lists"}