diff --git a/.github/instructions/doc-sync.instructions.md b/.github/instructions/doc-sync.instructions.md index 1d79c67f..fa6aae81 100644 --- a/.github/instructions/doc-sync.instructions.md +++ b/.github/instructions/doc-sync.instructions.md @@ -5,8 +5,10 @@ description: "Rules to keep documentation synchronized with code changes" # Rules to keep documentation up-to-date -- Rule 1: Whenever changes are made to the codebase, it's important to also update the documentation to reflect those changes. You must ensure that the following documentation is updated: [Starlight content pages in docs/src/content/docs/](../../docs/src/content/docs/). Each page uses Starlight frontmatter (title, sidebar order). Cross-page links use relative paths (e.g., `../../guides/compilation/`). +- Rule 1: Whenever changes are made to the codebase, it is important to also update the documentation to reflect those changes. You must ensure that the following documentation is updated: [Starlight content pages in docs/src/content/docs/](../../docs/src/content/docs/). Each page uses Starlight frontmatter (title, sidebar order). Cross-page links use relative paths (e.g., `../../guides/compilation/`). -- Rule 2: The main [README.md](../../README.md) file is a special case that requires user approval before changes, so, if there is a deviation in the code that affects what is stated in the main [README.md](../../README.md) file, you must warn the user and describe the drift and [README.md](../../README.md) update proposal, and wait for confirmation before updating it. +- Rule 2: The main [README.md](../../README.md) file is a special case that requires user approval before changes, so, if there is a deviation in the code that affects what is stated in the main [README.md](../../README.md) file, you must warn the user and describe the drift and [README.md](../../README.md) update proposal, and wait for confirmation before updating it. -- Rule 3: Documentation is meant to be very simple and straightforward, we must avoid bloating it with unnecessary information. It must be pragmatic, to the point, succint and practical.To: "**" \ No newline at end of file +- Rule 3: Documentation is meant to be very simple and straightforward, we must avoid bloating it with unnecessary information. It must be pragmatic, to the point, succinct and practical. + +- Rule 4: When changing CLI commands, flags, dependency formats, authentication flow, policy schema, or primitive file formats, also update the corresponding resource files in [packages/apm-guide/.apm/skills/apm-usage/](../../packages/apm-guide/.apm/skills/apm-usage/). Map changes to the correct file: commands.md for CLI changes, dependencies.md for reference formats, authentication.md for token resolution, governance.md for policy schema, package-authoring.md for primitive formats. diff --git a/packages/apm-guide/.apm/agents/apm-expert.agent.md b/packages/apm-guide/.apm/agents/apm-expert.agent.md new file mode 100644 index 00000000..3ee2d835 --- /dev/null +++ b/packages/apm-guide/.apm/agents/apm-expert.agent.md @@ -0,0 +1,49 @@ +--- +name: apm-expert +description: > + Expert on APM (Agent Package Manager). Helps users install, configure, + author, and troubleshoot APM packages, dependencies, compilation, MCP + servers, and governance policies. +--- + +# APM Expert + +You are an expert on APM (Agent Package Manager), the open-source package +manager for AI coding agents by Microsoft. You help developers install, manage, +and author packages that deliver instructions, prompts, agents, skills, and MCP +server configurations to their projects. + +## When to use APM + +- Sharing reusable AI instructions, prompts, or agents across repos +- Installing community or org-wide coding standards packages +- Managing MCP server configurations declaratively +- Enforcing governance policies on AI agent dependencies +- Compiling agent context for targets like Codex or Gemini + +## When NOT to use APM + +- Managing traditional code libraries (use npm, pip, cargo, etc.) +- Deploying production applications or services +- Managing infrastructure or cloud resources +- Version-controlling non-AI configuration files +- Tasks unrelated to AI coding agent setup + +## Essential workflow (5 commands) + +```bash +apm init # 1. initialize project +apm install owner/package#v1.0.0 # 2. install dependencies +apm compile # 3. compile agent context +apm run