Repository navigation
Focus the CLI docs on users and rewrite the compute guide - #17
Merged
Merged
Conversation
Trim the Lightcone CLI section to user-facing pages, and rewrite the cluster guide as "Configuring compute": how to write ~/.lightcone/compute.yaml for local and Slurm compute, with and without GPUs, following lightcone-cli#245's provider-named offers. - Remove the contributor and maintainer pages: Developer corner, Architecture, Development setup, Testing, Extending, and the Engine internals section, since the engine has no stable API. Remove the Glossary and the CLI reference index too, and fix every link to them. - Trim Troubleshooting to "lc: command not found", git identity, and filing a bug. - Rename cluster.mdx to configuring-compute.mdx, redirect the old URL, and add a layered diagram of how lc reaches compute (ComputeLayers). - Show the command pages directly under Reference, in monospace. - Give Core concepts a lightbulb icon and drop the book icon from every Guides heading. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Add a Resources subsection after the first Slurm configuration, explaining cpus, memory and accelerators and how launch flags match them, and fold the Slurm GPU subsection into it. - Name clusters explicitly in launch examples (--name analysis). - Explain startup in its own subsection, with a fast/batch example and a callout saying it is only a label for choosing between offers. - Move Perlmutter into a closing "Examples on known Slurm computers" section. - Remove "What a recipe needs" and "When a launch is refused", and the links from lc run and lc materialize that pointed at them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
This trims the Lightcone CLI docs to what users need, and rewrites the cluster guide as Configuring compute: how to write
~/.lightcone/compute.yamlfor local and Slurm compute, with and without GPUs.The guide documents the
compute.yamlformat from LightconeResearch/lightcone-cli#245, so it should merge once that PR is merged and released. The Installation page still pinslightcone-cli==0.5.0rc5, which predates it.Configuring compute
providerallow_local: falseCUDA_VISIBLE_DEVICEScpus,memoryand GPUs (generic or withgpu_type)startupmeans, in a calloutconnection_rootComputeLayers(components/compute-layers.tsx) showslc runandlc materializeon top oflc compute, on top of the providers. It's built like the existingStackLayers. Fumadocs' only built-in diagram support is Mermaid, which can't draw this layout well and would need themermaidpackage.cluster.mdxis nowconfiguring-compute.mdx, and/lightcone-cli/clusterredirects to it fromvercel.json. Every link into the old page and its sections is updated.lc computepage updated to match: providers instead of connections,allow_local, local GPUs, and noschema_versionin the JSON output.Trimmed CLI section
lib/source.ts.Small polish
Checks
npm run buildpasses (131 static pages) andtsc --noEmitis clean.compute.yamlexample in the guide was loaded with lightcone-cli atbd25f44, the current head of #245, usinglc compute resources. Excerpts were merged into a complete file first. The launches the guide describes were planned withlc compute launch --dry-run. Nothing was submitted to a real Slurm cluster, and the NERSC example says so.🤖 Generated with Claude Code