mirror of
https://github.com/0xrsydn/idx-cli.git
synced 2026-11-07 09:45:36 +00:00
feat(web): idx website and user docs (Astro Starlight)
Landing page plus docs for install, quickstart, config, the stocks and ownership CLI, output and exit codes, the MCP server and per-agent setup, agent usage, and an agent-led install page (agents/install.md) that a coding agent follows from a one-line prompt. - Every docs page is also served as Markdown at <path>.md; llms.txt and llms-full.txt come from starlight-llms-txt; a SKILL.md for skill-based harnesses is under /skills/idx/. - The CLI reference and MCP tools pages are generated from idx --help and the tools golden; a new web-generated flake check fails when they drift. - nix develop .#web provides bun; Cloudflare Pages builds web/ on pushes. - Package homepage metadata points at https://idx.rasyidanaf.com. - .cloudflare/ (the cf CLI's account cache) is git-ignored. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
e231061820
commit
e6805474f5
37 changed files with 3629 additions and 4 deletions
|
|
@ -23,6 +23,7 @@ crates/idx-cli/ binary `idx`
|
|||
crates/idx-mcp/ binary `idx-mcp`: stdio MCP tools (server.rs), inputs (params.rs)
|
||||
└── tests/mcp.rs JSON-RPC over stdio against the mock provider
|
||||
tests/agents/ opt-in agent smoke test: real coding agents against idx-mcp
|
||||
web/ website + user docs (Astro Starlight, bun); deployed by Cloudflare Pages
|
||||
scripts/ smoke, installer, and ownership snapshot publisher
|
||||
```
|
||||
|
||||
|
|
@ -54,4 +55,11 @@ nix flake check -L # canonical gate (fmt, clippy, tests, p
|
|||
nix develop --command cargo test <name> # focused loop
|
||||
scripts/live-smoke.sh --compare <old> # live drift check, A/B against an older build
|
||||
tests/agents/agent-smoke.sh # after changing idx-mcp tools: real agents, opt-in
|
||||
nix develop .#web --command sh -c 'cd web && bun install && bun run build' # website
|
||||
```
|
||||
|
||||
## Website
|
||||
User-facing docs live in `web/src/content/docs/`; `docs/` is for maintainers.
|
||||
When CLI help or idx-mcp tools change, regenerate the reference pages
|
||||
(`web/scripts/gen-cli-reference.sh <idx>` and `web/scripts/gen-mcp-tools.sh
|
||||
crates/idx-mcp/tests/golden/tools.json`); `nix flake check` fails until you do.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue