Skip to content

Commit 487c07f

Browse files
committed
docs: add a Pages entry point that routes to the real sources
1 parent b776e5d commit 487c07f

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

‎docs/index.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Intent-Router
2+
3+
**An intent compiler for AI agents.** It converges a vague request into a typed `IntentSpec` —
4+
looking up what it can, asking only what it cannot, and refusing to emit while the intent is still
5+
underspecified.
6+
7+
This page is the site entry point. The authoritative sources live in the repository:
8+
9+
| | |
10+
|---|---|
11+
| **[README](https://github.com/angel291592/Intent-Router/blob/main/README.md)** | What it is, what "installed" changes in the diff, backends, quick start |
12+
| **[README (中文)](https://github.com/angel291592/Intent-Router/blob/main/README.zh-CN.md)** | 中文说明 |
13+
| **[SKILL.md 中文导读](zh-CN/skill-guide.md)** | 逐节解释 SKILL.md 为什么这么写、删掉会发生什么 |
14+
| **[SKILL.md](https://github.com/angel291592/Intent-Router/blob/main/skills/intent-router/SKILL.md)** | The English single source — the only executable version |
15+
| **[Evals](https://github.com/angel291592/Intent-Router/tree/main/evals)** | Cases, runner, and the published reports |
16+
| **[CHANGELOG](https://github.com/angel291592/Intent-Router/blob/main/CHANGELOG.md)** | Release history and verification results |
17+
18+
## What it looks like
19+
20+
Three passes, in compiler order: **Parse** the request into a draft spec, **Resolve** every open
21+
question by looking it up or asking, then **Typecheck and emit** — route, ask, or halt.
22+
23+
![Probe](assets/demo-1-probe.png)
24+
25+
![Ask](assets/demo-2-question.png)
26+
27+
![Spec](assets/demo-3-spec.png)
28+
29+
## Get it
30+
31+
```bash
32+
git clone https://github.com/angel291592/Intent-Router.git
33+
```
34+
35+
See [Quick start](https://github.com/angel291592/Intent-Router/blob/main/README.md#quick-start) for
36+
the per-harness install paths, and
37+
[CONTRIBUTING](https://github.com/angel291592/Intent-Router/blob/main/CONTRIBUTING.md) for what PRs
38+
are checked against and how to run the evals locally.
39+
40+
## Discuss
41+
42+
Questions and design discussions belong in
43+
[Discussions](https://github.com/angel291592/Intent-Router/discussions); bugs in
44+
[Issues](https://github.com/angel291592/Intent-Router/issues). Security reports go through
45+
[private advisories](https://github.com/angel291592/Intent-Router/security/advisories/new), never a
46+
public issue.

0 commit comments

Comments
 (0)