Skip to content

Commit 93f4041

Browse files
committed
docs: add quickstart guide
1 parent b7dc12e commit 93f4041

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

docs/methodology/quickstart.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Quickstart
2+
3+
Use this page to apply AI-OS to any repository.
4+
5+
## Quickstart loop
6+
7+
```mermaid
8+
flowchart TD
9+
A[Choose task] --> B[Read AGENTS.md]
10+
B --> C[Load project context]
11+
C --> D[Select loop]
12+
D --> E[Plan]
13+
E --> F[Work in increments]
14+
F --> G[Verify]
15+
G --> H{Done?}
16+
H -- No --> F
17+
H -- Yes --> I[Report]
18+
```
19+
20+
## Minimal prompt
21+
22+
```text
23+
Execute AI-OS.
24+
Task: [describe task]
25+
Load context, choose the loop, plan, work, verify, and report evidence.
26+
```
27+
28+
## First repository setup
29+
30+
1. Add `AGENTS.md`.
31+
2. Add project context.
32+
3. Add verifier commands.
33+
4. Add loop-specific prompts.
34+
5. Add CI checks.

0 commit comments

Comments
 (0)