Skip to content

Port the component documentation - #12

Merged
EiffL merged 5 commits into
stack-sectionfrom
component-sections
Sep 30, 2026
Merged

EiffL merged 5 commits into
stack-sectionfrom
component-sections

Conversation

@EiffL

@EiffL EiffL commented Sep 30, 2026 •

Copy link
Copy Markdown
Member

Fills in the four component sections. Their existing documentation is converted from Zensical/MkDocs Markdown to MDX, taken from each component repository's main branch. Lightcone Lab had no docs, so its section is written from its README and source.

Stacked on #11, which is stacked on #10. Merge those first; GitHub then retargets this PR.

Sections

Section Pages Source
Lightcone CLI 31 lightcone-cli docs/
MySTRA 10 MySTRA docs/
Agent Skills 6 agent-skills README, docs/, plugins/, CONTRIBUTING, AGENTS.md
Lightcone Lab 6 (new) jupyterlab-lightcone README, CONTRIBUTING, RELEASE, schema/, src/
  • Lightcone CLI: overview, then three groups.
    • Guide: installing the CLI (only what /installation doesn't cover), getting started, core concepts, running on a cluster, troubleshooting, glossary.
    • Reference: the CLI reference and one page per command.
    • Internals: developer corner, architecture, the engine module tours, contributing.
  • MySTRA: overview, getting started, authoring (paths, inline references, block embeds, live values, multi-page), and reference (configuration, theming).
  • Agent Skills: overview, installation, the lightcone and astra plugins, hooks, contributing. The tutorial isn't repeated: it lives at /guides/first-analysis and is linked from the overview. It was briefly also in this section's sidebar, but Fumadocs finds the active project from the URL, so a URL listed twice made the guide page switch the selector to Agent Skills.
  • Lightcone Lab: overview, installation (browser-only vs full), a tour of the workbench, agents, settings and shortcuts, contributing. Behaviour is checked against the code where the README was vague.

How the syntax was converted:

  • admonitions → Callout;
  • collapsible admonitions → Accordions;
  • content tabs → code-block tabs or Tabs;
  • grid cards and buttons → Cards;
  • relative .md links → site paths;
  • MyST {astra} syntax kept inside code.

The build generates all 61 pages. A crawl of the built site finds no broken internal links or anchors.

One sidebar shape for every section

Every section now follows the stack's layout:

  • Introduction: Getting started first, then Overview and Installation.
  • Guides: with the Book icon, which the stack's Guides already had.
  • Reference.
  • Contributing.

So the project selector opens each section on its Getting started page. To make that possible:

  • New pages: Agent Skills and Lightcone Lab get a short Getting started page, built from their installation, plugin and workbench pages.
  • Stack Guides: it becomes a group like the others instead of a folder.
  • Titles: the CLI's "Installing the CLI" is now "Installation", and the Agent Skills and Lab "Contributing" pages are now "Development", so no label repeats.

Other commits in this PR

  • Stack sidebar icons and the "Introduction" separator: your edits, committed as they were.
  • Section icons: each section's intro pages get the matching icon. Overview has the question mark, like "What is", getting started has the rocket, and installation has the wrench.
  • Two fixes on the stack pages:
    • The Codex app calls skills with /…; only the Codex CLI uses $….
    • Report previews need Node.js 20 or newer, not 18, as MySTRA and Lab both state.

Out of date in the sources (worth fixing upstream)

  • lightcone-cli: idle timeout vs rc5. main documents local clusters that stop after 30 idle minutes (#234). That landed after v0.5.0rc5, the version the docs tell people to install. Under rc5, a local cluster has a fixed lifetime. This affects the cluster page, lc compute, the compute internals and step 5 of getting started. It needs a release, or a note on those pages.
  • lightcone-cli: contributing/setup still describes building the old Zensical site.
  • agent-skills:
    • The astra plugin's description mentions a reminder when the agent reads an ASTRA file; in fact it fires at session start.
    • The README says uv is the only prerequisite, but lightcone also needs lc.
    • AGENTS.md says CI runs npm test; no workflow does.
  • MySTRA:
    • The "pin a version" example uses v0.0.1, but the latest tag is v0.0.8.
    • theming.md refers to an astra-theme, while lc init uses astra-article-theme.
  • jupyterlab-lightcone:
    • The README says both installs read papers from arXiv; in the full install they come from the ASTRA cache.
    • CONTRIBUTING runs jlpm install before the pip install that provides jlpm.

Not verified

  • Lightcone Lab: I didn't run JupyterLab. UI labels come from the code and the UI tests.
  • Agent Skills:
    • Whether hooks run in the desktop apps isn't documented.
    • $lightcone:astra for Codex is inferred from the naming rule.
  • The per-repo docs sites (lightcone-cli, agent-skills, MySTRA on GitHub Pages) still exist. They can redirect here once this is merged.

Testing

  • npm run types:check and npm run build pass: 59 pages.
  • A crawl of out/ finds every internal link and anchor.
  • Checked in a browser:
    • the selector on every section and on the guide page;
    • each section's sidebar, including the icons;
    • MySTRA's MyST-heavy pages and the Lab tour.

🤖 Generated with Claude Code

EiffL and others added 4 commits September 29, 2026 21:11
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The Codex app calls skills with /…, like Claude; only the Codex CLI uses
$…. The MySTRA docs and Lightcone Lab both require Node.js 20 or newer
for MyST, not 18.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Each component's section now holds its documentation, converted from
Zensical/MkDocs Markdown to MDX (callouts, tabs, cards, accordions,
site-relative links) from the component repository's main branch:

- Lightcone CLI (31 pages, from lightcone-cli/docs): overview, a guide
  (installing the CLI, getting started, core concepts, running on a
  cluster, troubleshooting, glossary), the command reference, and the
  internals (developer corner, architecture, engine module tours,
  contributing). Install commands use the pinned pre-release, and
  getting started validates with uvx astra-tools@0.2.18.
- MySTRA (10 pages, from MySTRA/docs): overview, getting started,
  authoring (paths, inline references, block embeds, live values,
  multi-page) and reference (configuration, theming).
- Agent Skills (6 pages, from the agent-skills README, docs and
  plugins): overview, installation, the lightcone and astra plugins,
  hooks and contributing. The tutorial lives at /guides/first-analysis
  and is linked from the overview rather than repeated in the nav, since
  a URL may appear only once in the page tree.
- Lightcone Lab (6 pages, new, from the jupyterlab-lightcone README,
  CONTRIBUTING and source): overview, installation, a tour of the
  workbench, agents, settings and shortcuts, and contributing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Overviews take the "What is" icon, getting-started pages the Quick
Start's rocket, and installation pages the wrench, so the same kind of
page looks the same in every section's sidebar.

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

vercel Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Sep 30, 2026 4:19am UTC

Request Review

Each section now follows the stack's: an Introduction group that opens
with Getting started, then Overview and Installation, followed by
Guides, Reference and Contributing groups. The project selector
therefore opens each section on its Getting started page.

- Agent Skills and Lightcone Lab get a short Getting started page, built
  from their installation, plugin and workbench pages.
- The stack's Guides folder becomes a Guides group like the others,
  keeping its Book icon, which every section's Guides group now shares.
- Same kind of page, same title: the CLI's "Installing the CLI" becomes
  "Installation"; the Agent Skills and Lab "Contributing" pages become
  "Development" under the Contributing group; the engine internals
  overview opens from its folder instead of being listed twice.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@EiffL
EiffL added this pull request to stack #13 September 30, 2026 04:21
@EiffL
EiffL merged commit d4a7e25 into main Sep 30, 2026
2 checks passed

This branch was successfully deployed

1 active deployment
Preview — 619dd86a Deployed Sep 30, 2026 by vercel[bot]
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