Goal
Improve the discoverability and usability of the new agent instruction templates (templates/agents/) by ensuring there is clear, accessible example documentation or onboarding guide that shows new projects how to bootstrap with these templates.
Rationale
PR #29 introduces three new agent instruction templates:
templates/agents/global-agent-instructions.md
templates/agents/project-agents.md
templates/agents/github-copilot-instructions.md
However, it may not be immediately clear to new users or projects:
- Where these templates are located
- How to use them in a new project setup
- What the relationship and priority order is between the three templates
- Where to copy them and what to customize
First Step: Audit Existing Documentation
Before implementing this improvement, audit the existing documentation to check whether:
If any of these exist but feel unclear, document which ones need improvement.
Implementation
If gaps are found, create or enhance documentation to include:
-
A top-level guide (e.g., templates/agents/README.md or a section in the main README) that explains:
- What the three templates are for
- The execution order (global → project → skill)
- When to use each template
- Link to
skills/bootstrap-project/SKILL.md for detailed setup instructions
-
Concrete examples showing:
- Where to place each template in a sample project
- What variables to replace (e.g.,
<project>, <toolkit-url>)
- How each template references the others
-
Quick-start checklist for new projects adopting the toolkit
Definition of Done
Goal
Improve the discoverability and usability of the new agent instruction templates (
templates/agents/) by ensuring there is clear, accessible example documentation or onboarding guide that shows new projects how to bootstrap with these templates.Rationale
PR #29 introduces three new agent instruction templates:
templates/agents/global-agent-instructions.mdtemplates/agents/project-agents.mdtemplates/agents/github-copilot-instructions.mdHowever, it may not be immediately clear to new users or projects:
First Step: Audit Existing Documentation
Before implementing this improvement, audit the existing documentation to check whether:
READMEintemplates/agents/already exists that explains template usageREADME.mdalready contains links to or references these templatesskills/bootstrap-project/SKILL.mdalready provides sufficiently clear copy-paste examples (including which template goes where and what to customize)If any of these exist but feel unclear, document which ones need improvement.
Implementation
If gaps are found, create or enhance documentation to include:
A top-level guide (e.g.,
templates/agents/README.mdor a section in the main README) that explains:skills/bootstrap-project/SKILL.mdfor detailed setup instructionsConcrete examples showing:
<project>,<toolkit-url>)Quick-start checklist for new projects adopting the toolkit
Definition of Done