Skip to content

Commit 476ee9e

Browse files
Kasper Jungeclaude
authored andcommitted
docs: streamline docs homepage for users who want to quickly evaluate agr
The docs landing page was 180+ lines mixing getting-started content with reference material already covered on other pages. A new user had to scroll through handle format details, skill discovery mechanics, project setup, and migration instructions just to get oriented. Changes: - Add "What are skills?" section explaining the problem agr solves - Show the invocation table inline so users see immediate value - Remove Handle Format section (covered in Tutorial + Core Concepts) - Remove Skill Discovery section (covered in Core Concepts) - Remove Project Setup section (covered in Tutorial) - Remove Migration section (covered in Guides) - Remove Create a Skill shortcut (covered in Tutorial + Creating Skills) - Tighten Next Steps to 6 focused links The page is now ~120 lines focused on: understand → install → use → next steps. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent ebfad85 commit 476ee9e

1 file changed

Lines changed: 40 additions & 101 deletions

File tree

docs/docs/index.md

Lines changed: 40 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,21 @@ title: Home
44

55
# AGR — Skills for AI Agents
66

7-
A package and project manager for AI agent skills. Install, share, and run skills from GitHub with a single command.
7+
A package manager for AI agent skills. Install, share, and run skills across
8+
Claude Code, Cursor, Codex, OpenCode, Copilot, and Antigravity — with a single
9+
command.
10+
11+
## What are skills?
12+
13+
Skills are reusable instructions that teach AI coding agents how to perform
14+
specific tasks — reviewing code, generating components, preparing releases, or
15+
anything else you'd normally explain in a prompt. Each skill is a `SKILL.md`
16+
file in a directory, published on GitHub.
17+
18+
Without a package manager, you'd copy these files manually into each tool's
19+
config folder, keep them updated by hand, and hope your teammates have the same
20+
versions. **agr automates all of that** — install from GitHub, sync across
21+
tools, share via `agr.toml`.
822

923
## Install
1024

@@ -26,36 +40,36 @@ A package and project manager for AI agent skills. Install, share, and run skill
2640
pip install agr
2741
```
2842

29-
## Choose Your Path
30-
31-
### Install a Skill (persist it)
43+
## Add your first skill
3244

3345
```bash
3446
agr add anthropics/skills/frontend-design
3547
```
3648

37-
This installs the skill into your tool's skills folder. Once installed, invoke
38-
it in your tool — type `/frontend-design` in Claude Code or Cursor,
39-
`$frontend-design` in Codex, or just `frontend-design` in OpenCode. Use
40-
`--source <name>` to pick a non-default source from `agr.toml`.
49+
That's it. The skill is now installed in your tool's skills folder. Invoke it:
50+
51+
| Tool | Invoke with |
52+
|------|-------------|
53+
| Claude Code | `/frontend-design` |
54+
| Cursor | `/frontend-design` |
55+
| OpenAI Codex | `$frontend-design` |
56+
| OpenCode | `frontend-design` |
57+
| GitHub Copilot | `/frontend-design` |
4158

4259
!!! tip "No setup required"
4360
`agr add` auto-creates `agr.toml` if it doesn't exist and detects which
44-
tools you use. You don't need to run `agr init` first — just start adding
45-
skills.
61+
tools you use. You don't need to run `agr init` first.
4662

47-
### Run a Skill Once (no install)
63+
## Run a skill without installing
4864

4965
```bash
50-
agrx anthropics/skills/pdf # Run once, then clean up
5166
agrx anthropics/skills/pdf -p "Extract tables from report.pdf"
52-
agrx anthropics/skills/pdf -i # Interactive: run skill, then continue chatting
5367
```
5468

55-
The `-i` flag runs the skill first, then starts an interactive session so you can
56-
continue the conversation.
69+
`agrx` downloads the skill, runs it with your tool, and cleans up. Nothing is
70+
saved to your project.
5771

58-
### Share with Your Team
72+
## Sync skills across a team
5973

6074
Dependencies are tracked in `agr.toml`:
6175

@@ -72,22 +86,7 @@ Teammates install everything with:
7286
agr sync
7387
```
7488

75-
### Create a Skill
76-
77-
```bash
78-
agr init my-skill
79-
```
80-
81-
Then edit `my-skill/SKILL.md`. If you want it in this repo, place it under
82-
`./skills/`.
83-
84-
### Migrate Old Rules or Commands
85-
86-
```bash
87-
agrx kasperjunge/migrate-to-skills
88-
```
89-
90-
## Commands (Quick Reference)
89+
## Commands
9190

9291
| Command | What it does |
9392
|---------|-------------|
@@ -100,82 +99,22 @@ agrx kasperjunge/migrate-to-skills
10099
| `agr onboard` | Interactive guided setup |
101100
| `agrx <handle>` | Run a skill temporarily |
102101

103-
## Handle Format
104-
105-
```bash
106-
agr add user/skill # From user's "skills" repo
107-
agr add user/repo/skill # From a different repo
108-
agr add ./path/to/skill # Local path
109-
```
110-
111-
If a user's repo is named `skills`, you can skip the repo name:
112-
113-
```bash
114-
agr add kasperjunge/commit # From kasperjunge/skills
115-
agr add kasperjunge/skills/commit # Same thing (explicit)
116-
```
117-
118-
Note: `user/skill` now defaults to `skills`. During a deprecation period, agr
119-
will fall back to `agent-resources` (with a warning) if the skill isn't found in
120-
`skills`.
121-
122-
## How Skill Discovery Works
123-
124-
When you run `agr add user/repo/skill`, agr recursively searches the entire repo
125-
for any directory named `skill` that contains a `SKILL.md` file. Common locations
126-
include:
127-
128-
- `skills/{skill}/SKILL.md`
129-
- `resources/skills/{skill}/SKILL.md`
130-
- `{skill}/SKILL.md`
131-
132-
but any nesting depth works. Directories like `.git`, `node_modules`, `__pycache__`,
133-
and other common non-source directories are excluded from the search. When multiple
134-
matches exist, the shallowest path wins.
135-
136-
## Project Setup
137-
138-
```bash
139-
agr init # Create agr.toml (auto-detects tools)
140-
agr onboard # Interactive guided setup
141-
```
142-
143-
`agr init` creates `agr.toml` and detects which tools you use from repo signals
144-
(`.claude/`, `CLAUDE.md`, `.cursor/`, `.cursorrules`, etc.).
145-
146-
`agr onboard` walks you through tool selection, skill discovery, migration from
147-
tool folders into `./skills/`, and configuration.
148-
149-
## Example Skills
102+
## Example skills
150103

151104
```bash
152105
agr add anthropics/skills/frontend-design # Build production-grade UIs
153106
agr add anthropics/skills/skill-creator # Create new skills
154107
agr add anthropics/skills/pdf # Work with PDF documents
155108
```
156109

157-
Browse more at [github.com/anthropics/skills](https://github.com/anthropics/skills).
158-
159-
## Migrating from Rules, Subagents, or Slash Commands?
160-
161-
Most AI coding agents are converging on skills as the standard format. If you
162-
have old `.claude/commands/`, `.cursorrules`, or similar files, convert them:
163-
164-
```bash
165-
agrx kasperjunge/migrate-to-skills
166-
agrx kasperjunge/migrate-to-skills -p "convert files in ./my-commands"
167-
```
168-
169-
See [Guides — Migrating](guides.md#migrating-from-manual-skill-management) for
170-
a full walkthrough.
110+
Browse more at the [Skill Directory](skills.md) or on
111+
[GitHub](https://github.com/anthropics/skills).
171112

172-
## Next Steps
113+
## Next steps
173114

174115
- [Tutorial](tutorial.md) — hands-on walkthrough from zero to sharing skills
175-
- [Core Concepts](concepts.md) — understand handles, tools, sources, scopes, and the install flow
176-
- [Supported Tools](tools.md) — how agr works with Claude Code, Cursor, Codex, OpenCode, Copilot, and Antigravity
177-
- [Guides](guides.md) — practical recipes for updating, teams, CI/CD, and more
178-
- [Create your own skill](creating.md)
179-
- [Python SDK](sdk.md) — use agr as a library
180-
- [Troubleshooting](troubleshooting.md) — common errors and how to fix them
181-
- [CLI reference](reference.md)
116+
- [Core Concepts](concepts.md) — understand handles, tools, sources, and how agr works
117+
- [Supported Tools](tools.md) — how agr works with each AI coding tool
118+
- [Creating Skills](creating.md) — write and publish your own skills
119+
- [Guides](guides.md) — team workflows, CI/CD, custom sources, and more
120+
- [CLI Reference](reference.md) — every command, flag, and option

0 commit comments

Comments
 (0)