-
Notifications
You must be signed in to change notification settings - Fork 2
Maintaining Public Agent Resources
Angie Jones edited this page May 18, 2026
·
1 revision
This page documents how to keep the public agents wiki aligned with aaif/public-agents.
In this wiki:
- An agent is a recipe-backed end-to-end workflow, usually under
recipes/. - A skill is reusable expertise, usually under
skills/<skill-name>/SKILL.md. - A supporting artifact is a file used by an agent or skill, such as an asset, reference, script, prompt, workflow, or documentation page.
When changing a skill:
- Update
skills/<skill-name>/SKILL.md. - Update supporting
assets/,references/, orscripts/as needed. - Update the relevant wiki skill page if the skill's purpose, usage, rules, or artifacts changed.
- Update Skill Catalog if the skill name, quick chooser text, source link, or artifact relationship changed.
- Update Supporting Artifacts if new files were added.
When adding a new skill:
- Create
skills/<skill-name>/SKILL.md. - Include clear frontmatter with
nameanddescription. - Add any supporting files under the skill directory.
- Update
skills/README.mdif the repository usage guidance changes. - Add a wiki page for the skill.
- Add it to Home, Skill Catalog, and _Sidebar.
- Document any supporting artifacts it uses.
A good skill wiki page should explain:
- What the skill does.
- When to use it.
- When not to use it.
- What decisions or outputs it helps with.
- What artifacts it uses.
- Where the source skill lives.
When adding a new public recipe-backed agent:
- Add the recipe under
recipes/. - Document required inputs, outputs, credentials, tools, and safety constraints.
- List every skill and supporting artifact the recipe relies on.
- Add a wiki page for the agent.
- Add it to Home, Agent Catalog, and _Sidebar.
- Update Supporting Artifacts if the agent uses new prompts, scripts, references, or assets.
A good agent wiki page should explain:
- What the agent does.
- Whether someone should use it for a given task.
- What input the user provides.
- What actions the agent takes.
- What output the user gets back.
- What skills it uses.
- What supporting artifacts it uses.
- Where the source recipe lives.
When changing GitHub Actions workflows:
- Update the workflow file under
.github/workflows/. - Update GitHub Actions Workflows if behavior, inputs, permissions, or secrets changed.
- Keep safety notes current, especially secret handling and logging guidance.
Before considering wiki updates done, verify:
- Links point to the correct GitHub repository and branch.
- Skill names match their
SKILL.mdfrontmatter. - Pages distinguish agents from skills from artifacts.
- Each skill page lists supporting artifacts.
- Each agent page lists skills and artifacts used.
- The sidebar includes every major page.