docs: include lance-context in the full website build - #8014
Merged
Conversation
lance-context has a docs/src tree in the same shape as the other subprojects, but nothing pulls it into lance.org. Wire it in alongside spark/ray/trino. - LANCE_CONTEXT_REPO (default $HOME/oss/lance-context), documented in the usage block like the others - docs/src -> docs/src/integrations/context, adding the nav entry only when the checkout is present, so a partial local build still works - CONTRIBUTING.md -> community/project-specific/context.md - clean-full-website.sh removes both, keeping make/clean symmetric Verified end-to-end: ran make-full-website.sh against a real lance-context checkout (all 12 pages copied, nav entry generated) and `mkdocs build` succeeds with the pages rendered under site/integrations/context/. Co-Authored-By: Claude <noreply@anthropic.com>
github-actions
Bot
added
A-docs
beinan
added a commit
to lance-format/lance-context
that referenced
this pull request
Jul 27, 2026
## Summary Switches the docs from a standalone GitHub Pages site to lance.org, which is how the other subprojects publish. I'd previously set up Pages here (#203, #206) and asked for the repo's Pages setting to be enabled. @jackye1995 pointed out that the org doesn't enable per-subproject Pages by design — public docs should build into lance.org. He's right, and it turns out the docs are already in exactly the right shape for it: lance.org is built from the `lance` repo, whose `make-full-website.sh` copies each subproject's `docs/src` into the main site. So the content stays; only the publishing route changes. ## Changes - **Add `.pages` nav files.** The main site uses the `awesome-pages` plugin, so navigation must come from `.pages` files rather than a hardcoded `nav:` block — otherwise these pages render unordered under lance.org. Enabling the plugin here too keeps local preview and the published site on one source of truth. - **Drop the hardcoded `nav:` from `mkdocs.yml`**, now redundant. - **`site_url` → `https://lance.org/integrations/context/`**, the address the docs will actually be served from. - **Remove `.github/workflows/docs.yml`.** It deployed to a Pages site that doesn't exist and can't be created without an org-level policy change, so it only ever produced a red X on `main`. ## Verification Ran `lance/docs/make-full-website.sh` against this checkout and built the full site: all 12 pages land under `site/integrations/context/`, and the nav nests correctly (`Quickstart`, `Rollouts (RolloutDB)`, `Rollout schema`, ... all appear in the sidebar). ## Depends on lance-format/lance#8014 — until that merges, this repo's docs simply aren't picked up by the website build. Nothing here breaks in the meantime; `mkdocs build --strict` still passes locally for preview. ## Follow-ups from the same conversation Two other things Jack raised, not in this PR: - **Developer guide → `CONTRIBUTING.md`**, which also auto-builds into lance.org. The lance-side PR already wires up the copy rule; this repo has no `CONTRIBUTING.md` yet, so that's a separate change. - **Discussions** are moving to lance-format/lance/discussions org-wide. Also worth cleaning up once this lands: the now-unused `gh-pages` branch on this repo. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
The previous commit taught make-full-website.sh about LANCE_CONTEXT_REPO, but publish-site never checks the repo out or sets the variable, so CI would take the warn_missing_repo path and silently skip the docs. The script's graceful degradation is right for local partial builds, but it also means an omission here fails quietly rather than loudly. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
Author
|
Pushed a second commit: the first one taught Worth noting the failure mode: the script's graceful degradation is right for local partial builds, but it means an omission in the workflow fails quietly rather than loudly. Easy to miss. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
lance-contexthas adocs/srctree in the same shape as the other subprojects, but nothing pulls it into lance.org. This wires it in alongside spark/ray/trino so its docs publish the same way they do.Context: I originally set up a standalone GitHub Pages site on the lance-context repo, and @jackye1995 pointed out that the org deliberately doesn't enable per-subproject Pages — public docs should build into lance.org instead. This is that change; the matching lance-context-side PR is lance-format/lance-context#212.
Changes
Follows the existing pattern exactly, in both scripts:
LANCE_CONTEXT_REPO(default$HOME/oss/lance-context), documented in the usage block like the othersdocs/src→docs/src/integrations/context, adding the nav entry only when the checkout is present, so a partial local build still works and just warnsCONTRIBUTING.md→community/project-specific/context.mdclean-full-website.shremoves both, keeping make/clean symmetricVerification
Ran the real thing rather than eyeballing the diff:
make-full-website.shagainst an actual lance-context checkout — all 12 pages copied,integrations/.pagesnav entry generated, no warning for contextmkdocs buildsucceeds; pages render undersite/integrations/context/with correct nav nesting (context/guide/quickstart/etc. are linked from the integrations index)clean-full-website.shremoves everything it addedNote on placement
I put it under Integrations since that's where the other subprojects live and it needs no new top-level section. It's arguably not an "integration" in the same sense as Spark or Trino — it's a storage engine built on Lance — so if you'd prefer a different home, say the word and I'll move it.
🤖 Generated with Claude Code