Skip to content

Clarify optional Codex/agent skills installation in README #27

@linhay

Description

@linhay

Summary

TritonKit includes useful Codex/agent skills under .agents/tritonkit-skills/, but the main README does not make the external skill installation path obvious. As an adopting project, it was easy to integrate or discuss the iOS runtime / CLI path while missing the skills entirely.

What I expected

The README would have a short section in the integration chooser or setup docs that says:

  • TritonKit also ships optional agent skills for adopting projects.
  • External users should install only the public skills from .agents/tritonkit-skills/public/.
  • Internal skills are for TritonKit repository maintenance and should not be installed by default in adopting projects.
  • Codex should be restarted after installing skills.

What I found

The root README clearly explains the iOS embedded runtime, macOS CLI, and Harmony / DevEco integration paths, but it does not surface the agent skills installation path.

The skills README does clarify the packaging boundary:

  • public/ is intended for external users / adopting projects.
  • internal/ is for TritonKit maintainers.
  • public release skills are currently:
    • tritonkit-dev-feedback
    • tritonkit-emulator-cli-takeover
    • tritonkit-real-project-regression

However, this is discoverable only after looking into .agents/tritonkit-skills/README.md.

Suggested fix

Add a small section to the root README, for example:

## Optional Agent Skills

TritonKit also provides optional Codex/agent skills for adopting projects.
Install only the public skills unless you are working inside the TritonKit repository itself:

- `.agents/tritonkit-skills/public/tritonkit-dev-feedback`
- `.agents/tritonkit-skills/public/tritonkit-emulator-cli-takeover`
- `.agents/tritonkit-skills/public/tritonkit-real-project-regression`

Internal skills under `.agents/tritonkit-skills/internal/` are for TritonKit maintainers and should not be installed by default in external projects.

After installing skills, restart Codex / the agent session so the new skills are discovered.

It may also help to include copy-pasteable installation commands if there is a preferred installer flow for Codex skills.

Impact

This would make it harder for adopting projects to accidentally skip TritonKit's automation guidance and would clarify the public/internal boundary before users install repo-maintenance-only skills.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions