Skip to content

feat: add Lance-HF docs to lance.org/integrations/huggingface/#5748

Merged
Xuanwo merged 4 commits intomainfrom
feat/lance-huggingface-docs
Jan 21, 2026
Merged

feat: add Lance-HF docs to lance.org/integrations/huggingface/#5748
Xuanwo merged 4 commits intomainfrom
feat/lance-huggingface-docs

Conversation

@prrao87
Copy link
Copy Markdown
Contributor

@prrao87 prrao87 commented Jan 19, 2026

Add Lance-Hugging Face docs to the docs deploy workflow by checking out the external repo and copying its index.md into huggingface.md during CI, keeping Hugging Face docs sourced from the integration repo without changing local docs.

@prrao87 prrao87 requested review from Xuanwo and jackye1995 January 19, 2026 01:28
@github-actions github-actions Bot added the enhancement New feature or request label Jan 19, 2026
@github-actions
Copy link
Copy Markdown
Contributor

PR Review

P0 Issue - Existing file will be overwritten:

The workflow copies lance-huggingface/docs/src/index.md to docs/src/integrations/huggingface.md, but this file already exists in the repository with different content. This will silently replace the existing documentation during the docs deployment.

Current content in repo (docs/src/integrations/huggingface.md):

  • Shows how to write HuggingFace datasets to Lance format using lance.write_dataset

External repo content (presumed to be different based on PR description):

  • Documentation from the lance-huggingface integration repo

Recommended actions:

  1. Either delete the existing docs/src/integrations/huggingface.md from this repo (if the external docs are intended to replace it)
  2. Or merge the content from both sources
  3. Or use a different filename (e.g., huggingface-integration.md) and update the .pages nav accordingly

Without this fix, the existing HuggingFace documentation will be lost from the deployed site.

@prrao87
Copy link
Copy Markdown
Contributor Author

prrao87 commented Jan 19, 2026

It's okay to overwrite the existing docs/integrations/huggingface.md file because it's a stub. The live docs page in the external repo for the HF integration is where the docs will ultimately live.

Comment thread .github/workflows/docs-deploy.yml Outdated
@jackye1995
Copy link
Copy Markdown
Contributor

and we can remove https://github.com/lance-format/lance/blob/main/docs/src/integrations/huggingface.md now

@prrao87
Copy link
Copy Markdown
Contributor Author

prrao87 commented Jan 20, 2026

Done!

@Xuanwo Xuanwo merged commit d19def8 into main Jan 21, 2026
5 checks passed
@Xuanwo Xuanwo deleted the feat/lance-huggingface-docs branch January 21, 2026 10:33
wojiaodoubao added a commit to wojiaodoubao/lance that referenced this pull request Jan 22, 2026
majin1102 pushed a commit to majin1102/lance that referenced this pull request Jan 23, 2026
…-format#5748)

Add Lance-Hugging Face docs to the docs deploy workflow by checking out
the external repo and copying its
[`index.md`](https://github.com/lance-format/lance-huggingface/blob/main/docs/src/index.md)
into `huggingface.md` during CI, keeping Hugging Face docs sourced from
the integration repo without changing local docs.
vivek-bharathan pushed a commit to vivek-bharathan/lance that referenced this pull request Feb 2, 2026
…-format#5748)

Add Lance-Hugging Face docs to the docs deploy workflow by checking out
the external repo and copying its
[`index.md`](https://github.com/lance-format/lance-huggingface/blob/main/docs/src/index.md)
into `huggingface.md` during CI, keeping Hugging Face docs sourced from
the integration repo without changing local docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants