Skip to content

Commit 0d98296

Browse files
committed
docs: add adoption guide
1 parent 5ca8718 commit 0d98296

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

docs/adoption/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Adoption Guide
2+
3+
Use this guide to apply AI-OS to a real project.
4+
5+
## Adoption flow
6+
7+
```mermaid
8+
flowchart TD
9+
A[Target repository] --> B[Add AGENTS.md]
10+
B --> C[Add project context]
11+
C --> D[Map commands]
12+
D --> E[Select loops]
13+
E --> F[Add verifiers]
14+
F --> G[Run first task]
15+
G --> H[Record memory]
16+
```
17+
18+
## Steps
19+
20+
1. Copy `templates/agent-instructions-template.md` into the target repository as `AGENTS.md`.
21+
2. Copy `templates/complete-project-context.md` into the target repository docs.
22+
3. Fill in build, test, lint, release, and security commands.
23+
4. Choose the relevant loop for the first task.
24+
5. Run the task through plan, work, verify, and document.
25+
6. Store lessons in project memory.
26+
27+
## Good first tasks
28+
29+
- improve README
30+
- add missing tests
31+
- repair CI docs
32+
- document release process
33+
- add repository context

0 commit comments

Comments
 (0)