Skip to content

Import the lightcone-cli docs as a starting point - #1

Merged
EiffL merged 2 commits into
mainfrom
import-lightcone-cli-docs
Sep 27, 2026
Merged

EiffL merged 2 commits into
mainfrom
import-lightcone-cli-docs

Conversation

@EiffL

@EiffL EiffL commented Sep 27, 2026 •

Copy link
Copy Markdown
Member

Summary

Seeds this repo with the documentation that currently lives in lightcone-cli, so the Lightcone Research stack docs can grow from here.

  • docs/ and zensical.toml are copied from lightcone-cli main @ 3aa823b. docs/ is byte-identical. In zensical.toml, the header repo link now points at LightconeResearch/docs and the mike versioning block is removed, so this is a single unversioned site. The site title is still "lightcone-cli".
  • pyproject.toml + uv.lock: a uv-managed build environment (zensical only). zensical resolves to 0.0.65 (lightcone-cli was on 0.0.34).
  • .github/workflows/build.yml: runs zensical build --strict on PRs and pushes to main.
  • README with local preview instructions.

Not in this PR

  • Versioning. How to version docs for components that release on different schedules is still open.
  • Deploy. docs.lightconeresearch.org is still served from lightcone-cli's gh-pages, which publishes a new version on each CLI release. Moving it here means moving the custom domain and deciding what happens to the existing versioned URLs (/0.4.1/, /latest/, …).
  • Unreleased lightcone-cli docs. The lc compute pages and the cluster.md rewrite on feat/explicit-compute-clusters aren't included, since they're unmerged. They'll need to be copied over once that branch lands.
  • lightcone-cli's check-docs.yml still reviews its local docs/. It needs pointing here once the docs are removed from that repo.

Test plan

  • uv sync --locked && uv run zensical build --strict: no issues, 31 pages
  • Served locally and checked the home page renders with the custom theme

🤖 Generated with Claude Code

EiffL and others added 2 commits September 27, 2026 15:53
Copy the docs/ tree and zensical.toml from lightcone-cli main @ 3aa823b,
unchanged except for the header repo link, which now points at this
repository. Add a uv-managed build environment (zensical + squidfunk's
mike fork), a lockfile, and a CI job that builds the site in strict mode.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Build a single, unversioned zensical site. Versioning for a multi-component
stack is still to be decided; mike was only ever needed for lightcone-cli's
release-tied snapshots.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@EiffL EiffL left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@EiffL
EiffL merged commit e2ed928 into main Sep 27, 2026
1 check passed
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