lance-format / lance-format/lance

docs: Improve docs pipeline for lance-duckdb connector

Open
#5,629 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Rust
Stars
7.1k
Forks
852
Avg merge
3d 18h
Merged PRs (30d)
272

Description

After #5613 got merged, this is the feedback on improving the pipeline to keep the lance.org docs site in sync with the main source in the lance-duckdb repo.

We should make this consistent with the other connector docs, so the doc stays in the connector repo and we build it into the main website only during deployment time?

This would require updating the lance-duckdb source to use mkdocs, so that it be worked into the Lance docs CI pipeline as these docs are built.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the lance-duckdb source and the existing Lance docs CI pipeline, especially how other connector documentation is built. Introduce the MkDocs-based connector documentation flow so it remains in the connector repository and is incorporated into the main site during deployment.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.