Skip to content

armgit / Ix

Public Imported from GitHub
0

Understand any codebase instantly. System intelligence for codebases, built for humans and AI.

docs: make the docs home a documentation page, not a splash

KageBinary0d8eb4bca3dd
diff --git a/docs-site/astro.config.mjs b/docs-site/astro.config.mjs
index 57e027f9..e29f3fd6 100644
--- a/docs-site/astro.config.mjs
+++ b/docs-site/astro.config.mjs
@@ -54,7 +54,12 @@ export default defineConfig({
sidebar: [
{
label: 'Getting started',
- items: ['getting-started/introduction', 'getting-started/installation', 'getting-started/quickstart'],
+ items: [
+ { label: 'Overview', link: '/' },
+ 'getting-started/introduction',
+ 'getting-started/installation',
+ 'getting-started/quickstart',
+ ],
},
{
label: 'Concepts',
diff --git a/docs-site/public/demo.gif b/docs-site/public/demo.gif
deleted file mode 100644
index 20029265..00000000
Binary files a/docs-site/public/demo.gif and /dev/null differ
diff --git a/docs-site/src/content/docs/index.mdx b/docs-site/src/content/docs/index.mdx
index be3fe7ed..d2bb49b7 100644
--- a/docs-site/src/content/docs/index.mdx
+++ b/docs-site/src/content/docs/index.mdx
@@ -1,70 +1,53 @@
---
-title: Ix Documentation
-description: Ix parses your repository into a persistent graph of symbols, calls and imports, so you and your coding agents can query structure instead of grepping and guessing.
-template: splash
-hero:
- title: |
- Understand any codebase <span class="accent">instantly.</span>
- image:
- html: '<img class="hero-demo" src="demo.gif" width="960" height="540" alt="Ix mapping a repository and answering explain, trace and impact queries in a terminal" />'
- tagline: Ix maps your repository into a persistent graph of symbols, calls and imports. You and your coding agents query that graph instead of grepping and guessing.
- actions:
- - text: Get started
- link: getting-started/quickstart/
- icon: right-arrow
- variant: primary
- - text: View on GitHub
- link: https://github.com/ix-infrastructure/Ix
- icon: github
- variant: minimal
+title: Ix documentation
+description: Install Ix, query your codebase's graph from the CLI or your AI agent, and look up every command, flag and endpoint.
---
-import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components'
+import { CardGrid, LinkCard } from '@astrojs/starlight/components'
-## Install in one line
+Ix maps a repository into a graph of its symbols, calls and imports, stored on your machine. You query the
+graph from the `ix` CLI, from AI agents over MCP, and in the Compass visualizer. These docs cover installing
+Ix, using it day to day, connecting your agents, and the full reference for every command, flag and endpoint.
+
+## Install
```bash
curl -fsSL https://ix-infra.com/install.sh | sh # macOS / Linux
```
-```powershell
-irm https://ix-infra.com/install.ps1 | iex # Windows (install Node.js 22+ and Docker Desktop first)
-```
-
-Then map a repository and ask it a question:
-
-```bash
-ix map . # build the graph for this repo
-ix explain AuthService # what is this, and what does it touch?
-ix impact verify_token # what breaks if I change this?
-```
+On Windows, or to see what the installer sets up, read [Installation](/getting-started/installation/).
-## What you can do with Ix
+## Start here
<CardGrid>
- <Card title="Answer structural questions" icon="magnifier">
- Find a symbol, see what calls it, follow a flow through the code, and measure the blast radius of a change.
- Each answer covers one symbol or flow instead of whole files.
- </Card>
- <Card title="Give your agents a map" icon="rocket">
- `ix mcp install` registers the graph tools with Claude Code, Codex, Cursor, VS Code, Gemini CLI, OpenClaw and
- opencode.
- </Card>
- <Card title="Keep context between sessions" icon="document">
- The graph lives on your machine and persists. Your architecture is mapped once, not rediscovered every session.
- </Card>
- <Card title="See the whole system" icon="puzzle">
- `ix view` opens Compass, an interactive visualizer of your codebase's structure.
- </Card>
+ <LinkCard title="Quickstart" description="Map a repository and run your first queries." href="getting-started/quickstart/" />
+ <LinkCard title="What is Ix?" description="What the graph holds and what it answers." href="getting-started/introduction/" />
+ <LinkCard title="Connect your AI agent" description="Register Ix's MCP server with your clients." href="integrations/overview/" />
+ <LinkCard title="Command reference" description="Every command, by the question it answers." href="reference/commands/" />
</CardGrid>
-## Where to go next
+## Browse the docs
-<CardGrid>
- <LinkCard title="Quickstart" description="Install Ix, map a repo and run your first queries." href="getting-started/quickstart/" />
- <LinkCard title="Connect your AI agent" description="Register Ix's MCP server with the clients you use." href="integrations/overview/" />
- <LinkCard title="Command reference" description="Every ix command, grouped by the question it answers." href="reference/commands/" />
- <LinkCard title="HTTP API" description="The local backend's endpoints, generated from the OpenAPI spec." href="api/overview/" />
-</CardGrid>
+**Concepts**
+- [How Ix works](/concepts/how-it-works/): the parser, the local backend and the three clients.
+- [Output formats](/concepts/output-formats/): `text`, `json` and `llm`, and setting a default.
+
+**Guides**
+- [Everyday workflows](/guides/everyday-workflows/): recipes for the questions developers ask most.
+- [Visualize with Compass](/guides/compass/): explore the graph in your browser.
+- [Troubleshooting](/guides/troubleshooting/): fixes for the most common problems.
+
+**AI agents**
+- [MCP server](/integrations/mcp/): the tools `ix mcp` serves and how clients are registered.
+- [Agent skill](/integrations/agent-skill/): teach an agent to drive the CLI.
+- [Native plugins](/integrations/plugins/): Claude Code, Codex, Cursor, Gemini CLI, OpenCode and OpenClaw.
+
+**Reference**
+- [Commands](/reference/commands/), [Flags](/reference/flags/) and [Configuration](/reference/configuration/).
+- [The llm output format](/reference/llm-format/) and [Supported languages](/reference/languages/).
+
+**HTTP API**
+- [Overview](/api/overview/), the [full reference](/api/reference/), and every endpoint, generated from the OpenAPI spec.
-Ix is open source under the Apache 2.0 license. Questions? Join us on [Discord](https://discord.gg/ncEYVHVqZ8).
+**Community**
+- [Contributing](/community/contributing/), [Security](/community/security/) and [Get help](/community/support/).
diff --git a/docs-site/src/styles/theme.css b/docs-site/src/styles/theme.css
index 2948280e..a6f03a78 100644
--- a/docs-site/src/styles/theme.css
+++ b/docs-site/src/styles/theme.css
@@ -36,15 +36,6 @@
--sl-color-black: #ffffff;
}
-/* Splash hero: the site's "instantly." blue on the headline's second line. */
-.hero h1 .accent {
- color: var(--sl-color-accent);
-}
-
-:root[data-theme='dark'] .hero {
- background: radial-gradient(ellipse 60% 70% at 70% 40%, rgba(72, 154, 241, 0.16), transparent 70%);
-}
-
.site-title img {
height: 1.6rem;
width: auto;
@@ -56,14 +47,6 @@
color: #ffffff;
}
-.hero-demo {
- width: 100%;
- height: auto;
- border-radius: 0.75rem;
- border: 1px solid var(--sl-color-gray-5);
- box-shadow: 0 18px 60px rgba(0, 0, 0, 0.45);
-}
-
/* The default current-page pill uses accent-high, which glares on navy. */
.sidebar-content a[aria-current='page'] {
background-color: var(--sl-color-accent-low);