Skip to content

docs: publish via lance.org instead of this repo's GitHub Pages - #213

Merged
beinan merged 1 commit into
lance-format:mainfrom
beinan:docs/lance-org-site
Jul 27, 2026
Merged

docs: publish via lance.org instead of this repo's GitHub Pages#213
beinan merged 1 commit into
lance-format:mainfrom
beinan:docs/lance-org-site

Conversation

@beinan

@beinan beinan commented Jul 27, 2026

Copy link
Copy Markdown
Collaborator

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_urlhttps://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

The org does not enable per-subproject Pages. lance.org is built from the
lance repo, whose make-full-website.sh copies each subproject's docs/src
into the main site; that is how lance-spark, ray, and trino publish.
Follow the same route.

- Add .pages nav files. The main site uses the awesome-pages plugin, so
  navigation has to come from .pages rather than a hardcoded nav block,
  or 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.
- Point site_url at the address the docs will actually be served from.
- Remove .github/workflows/docs.yml. It deployed to a Pages site that
  does not exist and cannot be created without an org-level policy
  change, so it only ever produced a red X on main.

Verified by running the real lance/docs/make-full-website.sh against this
checkout and building the full site: all 12 pages land under
site/integrations/context/ with correct nav nesting.

Requires lance-format/lance#7924 to be merged for the pages to appear.

Co-Authored-By: Claude <noreply@anthropic.com>
@beinan
beinan merged commit 4bcbfb6 into lance-format:main Jul 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant