Skip to content

Commit 024ef84

Browse files
committed
docs: integrate /learn command and skill system into documentation suite
1 parent 0de02e3 commit 024ef84

6 files changed

Lines changed: 51 additions & 3 deletions

File tree

docs/deploy.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ gemini /onboard
6969

7070
Check the current `TASKS.md` file and use the `/task` command to define your project's initial goals.
7171

72+
### 3. Codified Knowledge
73+
74+
Knowledge mastered via `/learn` is stored in `.gemini/skills/`. These are permanent project assets and **must** be tracked in version control to ensure the AI's long-term memory persists across environments.
75+
7276
### 3. Start a New Feature
7377

7478
For your first feature, follow the standard workflow:

docs/design.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,19 @@ The `pre-commit.py` hook implements a sophisticated cross-file validation strate
6464

6565
### 4. Specialized Agents (`.gemini/agents/`)
6666

67-
Instead of a single "do-it-all" AI, the framework delegates tasks to specialized sub-agents with restricted toolsets and focused personas (e.g., `planner`, `debugger`, `editor`, `reporter`). This ensures higher reliability and more consistent results.
67+
Instead of a single "do-it-all" AI, the framework delegates tasks to specialized sub-agents with restricted toolsets and focused personas.
68+
69+
- **`planner`:** Responsible for high-level architectural design and roadmap generation.
70+
- **`debugger`:** A forensic investigation specialist using a scientific, hypothesis-driven workflow.
71+
- **`learner`:** A "Grounded Learning Specialist" who master new technologies by writing, executing, and documenting code experiments.
72+
- **`reporter` / `editor`:** Content generation and refinement specialists.
73+
74+
### 5. The Skill System (`.gemini/skills/`)
75+
76+
The framework's permanent knowledge base. Each skill is a directory containing:
77+
- **`SKILL.md`:** The entry point with mandatory YAML frontmatter (`name` and `description`) for autonomous activation.
78+
- **`reference-*.md`:** Granular documentation for specific learning objectives.
79+
- **`assets/`:** Idiomatic, verified code examples and experiment scripts.
6880

6981
### 4. State Management
7082

docs/develop.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,28 @@ Failure to do this will block your commit or turn execution.
5656

5757
## ✅ Testing & Quality Standards
5858

59+
- **Agent-Driven Validation:** This project does **not** maintain a traditional suite of unit or integration tests (e.g., in a `tests/` directory). Instead, it relies on high-discipline agent execution and **Grounded Experimentation** to verify behavior.
5960
- **Source of Truth:** The `makefile` is the central definition of project health.
60-
- **Mandatory Commands:** Ensure `make test`, `make lint`, and `make format` pass before committing.
61-
- **Documentation-as-Code:** Any new feature must be accompanied by relevant updates to the `docs/` directory.
61+
- **TCR Protocol:** The primary mechanism for ensuring "Green-only" development is the mandatory **Test-Commit-Revert** loop during task execution.
62+
63+
## 🧠 Codifying Knowledge with Skills
64+
65+
The `/learn` command is the primary tool for expanding the project's knowledge base. All generated skills must adhere to the following structure:
66+
67+
### 1. Mandatory Frontmatter (`SKILL.md`)
68+
69+
The root `SKILL.md` file **must** include a YAML block at the top. This allows the framework to autonomously recognize and activate the skill in future sessions.
70+
71+
```yaml
72+
---
73+
name: <unique-identifier>
74+
description: <concise-summary-for-autonomous-activation>
75+
---
76+
```
77+
78+
### 2. Asset Management
79+
80+
Move all successful experiment scripts and idiomatic examples to the `assets/` subdirectory within the skill folder.
6281

6382
## 🌲 Git & Source Control
6483

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ curl -fsSL https://apiad.github.io/starter/install.sh | bash
4242
## 🛠️ Key Capabilities
4343

4444
- **Deep Discovery:** Use `/research` for multi-phase domain investigations.
45+
- **Knowledge Mastering:** Use `/learn` to explore and codify new libraries or topics into permanent project skills.
4546
- **Architectural Planning:** Use `/plan` to generate persistent, actionable strategies.
4647
- **Forensic Debugging:** Use `/debug` for root-cause analysis without immediate (and potentially incorrect) fixes.
4748
- **Automated Documentation:** Use `/docs` to keep the documentation synchronized with the evolving codebase.

docs/user-guide.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,17 @@ Your tool for internal strategy and architectural design.
3636
- **How it works:** The `planner` subagent conducts a thorough analysis of your codebase and journal. After clarifying the goal with you interactively, it produces a comprehensive Markdown plan in the `plans/` directory.
3737
- **Crucial Rule:** The `/plan` command *never* executes the code. It maps the territory and provides a step-by-step execution roadmap for you to approve first.
3838

39+
### `/learn`
40+
41+
Your tool for mastering new technologies and codifying them into project skills.
42+
43+
- **How it works:** Implements a "Grounded Learning" philosophy through a 4-phase lifecycle:
44+
1. **Environment Audit:** Automatically detects if the library is already installed or has local integration points.
45+
2. **Strategic Mapping:** Researches the topic and defines 3-5 granular Learning Objectives (the "Learning Map"). **Requires user approval via `ask_user`.**
46+
3. **Grounded Execution:** The specialized `learner` sub-agent performs real-world experiments (writing and running scripts) to verify "gotchas," performance, and idiomatic patterns.
47+
4. **Skill Codification:** Consolidates all findings into a permanent project skill in `.gemini/skills/<name>/`, including a mandatory `SKILL.md` file and reference documents.
48+
- **Why it works:** It transforms ephemeral research into a permanent, machine-readable knowledge base that future agents can autonomously activate.
49+
3950
---
4051

4152
## 💻 The Software Development Workflow

journal/2026-03-20.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@
2121
[2026-03-20T12:46:46] - Fixed SKILL.md formatting for pytest by adding YAML frontmatter.
2222
[2026-03-20T12:47:49] - Updated learn.toml command with explicit SKILL.md formatting instructions (YAML frontmatter).
2323
[2026-03-20T12:56:15] - Migrated tests to pytest, then cleaned up tests and makefile to finalize /learn command
24+
[2026-03-20T13:01:58] - Updated comprehensive documentation suite to include the new /learn command, grounded learning philosophy, and skill codification system

0 commit comments

Comments
 (0)