Goal
Improve discoverability of the new agent instruction templates by ensuring they are clearly referenced and linked from the main repository README, making it easy for new users and projects to find and understand these templates during onboarding.
Rationale
PR #29 adds three new agent instruction templates in templates/agents/:
global-agent-instructions.md
project-agents.md
github-copilot-instructions.md
These templates are critical for:
- Setting up new projects with the toolkit
- Configuring local agent installations
- Establishing a shared instruction contract across tools and projects
However, if the main README does not link to or prominently feature these templates, they may be hard for users to discover, especially when first exploring the repository or onboarding a new project.
First Step: Audit Main README
Before adding or updating links, check whether:
If links exist, assess whether they are prominent, clear, and easy to find.
Implementation
If gaps or unclear links are found, enhance the main README to include:
-
A dedicated section (e.g., "Agent Setup" or "Installation & Configuration") that:
- Explains what agent instructions are and why projects need them
- Lists the three templates and their purpose
- Provides links to each template file
- References the toolkit's
AGENTS.md and skills/bootstrap-project/SKILL.md for detailed guidance
-
A quick-reference table or checklist showing:
- Which template goes in which directory
- What each template is for
- Which audiences should use each one (individual developers, projects, teams, etc.)
-
Integration with existing README structure:
- Decide if this fits best in a "Getting Started" section, a "Templating" section, or "Project Setup"
- Ensure it is positioned early enough that new visitors see it
Definition of Done
Goal
Improve discoverability of the new agent instruction templates by ensuring they are clearly referenced and linked from the main repository README, making it easy for new users and projects to find and understand these templates during onboarding.
Rationale
PR #29 adds three new agent instruction templates in
templates/agents/:global-agent-instructions.mdproject-agents.mdgithub-copilot-instructions.mdThese templates are critical for:
However, if the main README does not link to or prominently feature these templates, they may be hard for users to discover, especially when first exploring the repository or onboarding a new project.
First Step: Audit Main README
Before adding or updating links, check whether:
README.mdalready contains a section about agent setup or instructionstemplates/agents/or individual template files already existIf links exist, assess whether they are prominent, clear, and easy to find.
Implementation
If gaps or unclear links are found, enhance the main README to include:
A dedicated section (e.g., "Agent Setup" or "Installation & Configuration") that:
AGENTS.mdandskills/bootstrap-project/SKILL.mdfor detailed guidanceA quick-reference table or checklist showing:
Integration with existing README structure:
Definition of Done