docs: CLI reference + reframe getting-started around two paths - #30
Merged
Conversation
New docs/cli.md covers `lectio dev` / `build`, zero-config scaffolding, docs.config and deploy. getting-started now leads with the fast CLI path, then the library path for embedding Lectio in your own app. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds missing CLI documentation and restructures the “Getting started” guide to present two supported adoption paths (CLI-first for a turnkey docs site, and library-first for embedding into an existing app).
Changes:
- Added a new CLI reference page covering
dev/build,docs.config.*, and deployment. - Reworked “Getting started” to lead with the CLI flow, then introduce the library flow and how they relate.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/getting-started.md | Reframes onboarding around CLI vs library usage paths and links to the new CLI page. |
| docs/cli.md | New CLI reference explaining lectio usage, configuration, and deployment. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+20
to
+21
| repo shows a site right away. See [The lectio CLI](/cli) for configuring | ||
| sources, branding and deploy. |
| into a static, searchable docs site — with no app code to write. | ||
|
|
||
| ```sh | ||
| npx lectio-docs dev # collect + serve locally, with live reload on the UI |
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.
The existing docs only covered the library API (they predate the CLI). This
adds the missing CLI path and frames the two ways to use Lectio.
docs/cli.md—lectio dev/build, zero-config scaffolding,docs.config.ts(sources, branding, editUrl), and deploy.docs/getting-started.md— leads with the fast CLI path, thenthe library path for embedding Lectio in your own app.
Verified: the demo site collects + prerenders both pages (
/cli,/getting-started).