Skip to content

Conversation

@betegon
Copy link
Member

@betegon betegon commented Dec 23, 2025

Addresses user feedback in Discord that the docs didn't clearly explain what options are available for running Spotlight.

Changes

Setup page (/docs/setup/)

  • Renamed to "Getting Started"
  • Now presents all three options (Desktop App, CLI, MCP Server) with comparison table
  • Added to sidebar navigation under "About"

CLI page (/docs/cli/)

  • Added intro explaining what the CLI is and why to use it
  • Added installation section with npx, npm, binary, and Docker options
  • Added all commands (run, tail, server, mcp) in one CardGrid
  • Replaced verbose comparison lists with a comparison table
  • Removed repetitive examples

@vercel
Copy link

vercel bot commented Dec 23, 2025

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

Project Deployment Review Updated (UTC)
spotlightjs Ready Ready Preview, Comment Dec 23, 2025 6:32pm

@betegon betegon merged commit 202e7c8 into main Dec 23, 2025
20 checks passed
@betegon betegon deleted the bete/docs-cli-clarification branch December 23, 2025 18:57
Copy link
Member

@BYK BYK left a comment

Choose a reason for hiding this comment

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

Great work!

<TabItem label="npx">
No installation needed:
```bash
npx @spotlightjs/spotlight run npm run dev
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
npx @spotlightjs/spotlight run npm run dev
npx @spotlightjs/spotlight run

Copy link
Member Author

Choose a reason for hiding this comment

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

good point.

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.

3 participants