Skip to content

docs: fix first-package guide (includes: auto explained, correct skill paths) #1129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danielmeppiel merged 1 commit into from
May 4, 2026
Merged

docs: fix first-package guide (includes: auto explained, correct skill paths) #1129

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions docs/src/content/docs/getting-started/first-package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,16 @@ author: your-handle
dependencies:
apm: []
mcp: []
includes: auto
scripts: {}
```

`includes: auto` is the field that makes step 4 work: with no remote
dependencies declared, `apm install` walks your local `.apm/` tree
and deploys what it finds. Set `includes: []` (or omit the field) and
local content stops deploying. Override with an explicit list of
paths to gate exactly what ships.
Comment on lines +55 to +59

## 2. Add a skill

A **skill** is a chunk of expertise that the runtime activates automatically
Expand Down Expand Up @@ -169,11 +176,17 @@ Output:

```
[+] <project root> (local)
|-- 1 agent integrated -> .github/agents/
|-- 1 skill(s) integrated -> .github/skills/
|-- 1 agents integrated -> .github/agents/
|-- 1 skill(s) integrated -> .agents/skills/
[i] Added apm_modules/ to .gitignore
```

Note the split: **agents** are runtime-specific and land under
`.github/agents/` (Copilot's directory). **Skills** land under
`.agents/skills/` -- the cross-client universal location that
Copilot, Cursor, OpenCode, Codex, and Gemini all read. Claude Code
is the exception: it reads `.claude/skills/`.

Your tree now has source on the left and runtime-ready output on the right:

```
Expand All @@ -183,9 +196,10 @@ team-skills/
| | +-- pr-description/SKILL.md
| +-- agents/
| +-- team-reviewer.agent.md
+-- .github/ # generated by apm install
+-- .agents/ # generated -- cross-client skills
| +-- skills/
| | +-- pr-description/SKILL.md
| +-- pr-description/SKILL.md
+-- .github/ # generated -- runtime-specific
| +-- agents/
| +-- team-reviewer.agent.md
+-- apm.yml
Expand Down
Loading