Port the component documentation - #12
Merged
Merged
Conversation
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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
added this pull request to stack #13
September 30, 2026 04:21
This branch was successfully deployed
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
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.
Fills in the four component sections. Their existing documentation is converted from Zensical/MkDocs Markdown to MDX, taken from each component repository's
mainbranch. 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
docs/docs/docs/,plugins/, CONTRIBUTING, AGENTS.mdschema/,src//installationdoesn't cover), getting started, core concepts, running on a cluster, troubleshooting, glossary./guides/first-analysisand 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.How the syntax was converted:
Callout;Accordions;Tabs;Cards;.mdlinks → site paths;{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:
So the project selector opens each section on its Getting started page. To make that possible:
Other commits in this PR
/…; only the Codex CLI uses$….Out of date in the sources (worth fixing upstream)
maindocuments local clusters that stop after 30 idle minutes (#234). That landed afterv0.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.contributing/setupstill describes building the old Zensical site.lc.npm test; no workflow does.v0.0.1, but the latest tag isv0.0.8.theming.mdrefers to anastra-theme, whilelc initusesastra-article-theme.jlpm installbefore the pip install that providesjlpm.Not verified
$lightcone:astrafor Codex is inferred from the naming rule.Testing
npm run types:checkandnpm run buildpass: 59 pages.out/finds every internal link and anchor.🤖 Generated with Claude Code