Skip to content

Commit f01df46

Browse files
authored
Add skills and docs (#321)
* Add vscode files * feat: Make repository AI-native with Agent Skills and comprehensive documentation - Add AGENTS.md as main guide for AI coding agents (OpenHands, Claude Code) - Create 7 Agent Skills in .agents/skills/ following Agent Skills standard: - add-ros2-package: Create new ROS 2 packages - integrate-module-into-layer: Integrate modules into bringup - write-isaac-sim-scene: Create Isaac Sim scenarios - debug-module: Autonomous debugging strategies - update-documentation: Documentation workflow - test-in-simulation: End-to-end simulation testing - add-behavior-tree-node: Create behavior tree nodes - Add package template with C++/Python examples in skill assets - Add system_architecture.md with mermaid diagrams showing data flow - Add integration_checklist.md with standard topics and requirements - Add ai_agent_guide.md as quick reference for agents - Update mkdocs.yml with new documentation sections - Convert CLAUDE.md to symlink to AGENTS.md Enables AI agents to quickly understand repository structure, implement features following established patterns, and autonomously debug and test. * Delete old files * Reorganize docs * Update logo and paths * Rename * Update docs * Improve docs and add docs skill * Improve docs * More docs * Fix lists * Improvements * Fix paths
1 parent 0180943 commit f01df46

File tree

95 files changed

+12457
-1037
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+12457
-1037
lines changed

.agents/README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# AirStack Agent Skills
2+
3+
This directory contains Agent Skills following the [Agent Skills standard](https://agentskills.io).
4+
5+
## Structure
6+
7+
```
8+
.agents/
9+
├── README.md # This file
10+
└── skills/ # Agent Skills directory
11+
├── add-ros2-package/
12+
│ └── SKILL.md # Create new ROS 2 packages
13+
├── integrate-module-into-layer/
14+
│ └── SKILL.md # Integrate modules into layer bringup
15+
├── write-isaac-sim-scene/
16+
│ └── SKILL.md # Create Isaac Sim simulation scenes
17+
├── debug-module/
18+
│ └── SKILL.md # Autonomous debugging strategies
19+
├── update-documentation/
20+
│ └── SKILL.md # Document modules and update mkdocs
21+
├── test-in-simulation/
22+
│ └── SKILL.md # End-to-end simulation testing
23+
└── add-behavior-tree-node/
24+
└── SKILL.md # Create behavior tree nodes
25+
```
26+
27+
## Skills Overview
28+
29+
Each skill is a directory containing a `SKILL.md` file with:
30+
- **YAML frontmatter:** Name, description, license, metadata
31+
- **Markdown body:** Step-by-step instructions for the workflow
32+
33+
### Available Skills
34+
35+
| Skill | Purpose |
36+
|-------|---------|
37+
| [add-ros2-package](skills/add-ros2-package) | Create a new ROS 2 package for the autonomy stack |
38+
| [integrate-module-into-layer](skills/integrate-module-into-layer) | Integrate a module into layer bringup |
39+
| [write-isaac-sim-scene](skills/write-isaac-sim-scene) | Create custom simulation environments |
40+
| [debug-module](skills/debug-module) | Systematically debug ROS 2 modules |
41+
| [update-documentation](skills/update-documentation) | Document modules and update mkdocs |
42+
| [test-in-simulation](skills/test-in-simulation) | Test modules in Isaac Sim |
43+
| [add-behavior-tree-node](skills/add-behavior-tree-node) | Create behavior tree nodes |
44+
45+
## Usage
46+
47+
Skills are designed for AI coding agents (OpenHands, Claude Code, etc.) to:
48+
49+
1. **Discover** skills through the description field
50+
2. **Activate** relevant skill when task matches
51+
3. **Follow** step-by-step instructions in SKILL.md
52+
4. **Reference** cross-linked skills for related workflows
53+
54+
## For Developers
55+
56+
When adding new skills:
57+
58+
1. Create directory with hyphenated name (e.g., `my-new-skill/`)
59+
2. Add `SKILL.md` with proper YAML frontmatter
60+
3. Follow Agent Skills format specification
61+
4. Reference related skills using relative paths (`../other-skill/`)
62+
5. Update this README with the new skill
63+
64+
## References
65+
66+
- **Main Guide:** [AGENTS.md](../AGENTS.md)
67+
- **Agent Skills Spec:** [https://agentskills.io](https://agentskills.io)
68+
- **System Architecture:** [docs/robot/autonomy/system_architecture.md](../docs/robot/autonomy/system_architecture.md)
69+
- **Integration Checklist:** [docs/robot/autonomy/integration_checklist.md](../docs/robot/autonomy/integration_checklist.md)
70+
- **AI Agent Guide:** [docs/development/ai_agent_guide.md](../docs/development/ai_agent_guide.md)

0 commit comments

Comments
 (0)