Skip to content

docs(integrations): fix target removal recipe, MCP paths and check names - #3811

Merged
Daniel Meppiel (danielmeppiel) merged 1 commit into
mainfrom
docs-sweep/integrations
Nov 18, 2026
Merged

Daniel Meppiel (danielmeppiel) merged 1 commit into
mainfrom
docs-sweep/integrations

Conversation

@danielmeppiel

@danielmeppiel Daniel Meppiel (danielmeppiel) commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Surgical fixes to integrations/*, checked against the target registry, the client adapters and scratch-directory runs on current main.

  • ide-tool-integration.md: the "remove a target" recipe said apm prune removes the dropped target's files. It does not ("No orphaned packages found"); the next apm install cleans them up. Also adds MCP config paths for Copilot CLI, Antigravity and Hermes, a Hermes row, the missing primitives for Claude, Cursor and Codex, and fixes a dead #target anchor.
  • copilot-app.md: non-workflow prompts are skipped with a warning, not an error. apm uninstall deletes the tracked rows. The quoted --global warning now includes its URL suffix.
  • github-rulesets.md: the required status check is the job id (audit), not the workflow name.
  • runtime-compatibility.md: adding a runtime now takes a single RuntimeDescriptor in runtime/registry.py.
  • copilot-cowork.md: skills deploy per skill name.

Pages that a still-open PR also edits are left out of this PR, as the approved scope requires. Their fixes are held for after those PRs land, and the sweep report lists them.

Issue and approved scope

Issue: Refs #3800

Human scope-approval comment: #3800 (comment)

Does this PR complete the issue, or what remains? Partial: one area batch of the corpus re-sweep. Pages edited by still-open PRs are not touched here; their findings are recorded in the final sweep report and re-checked after v0.36.1.

Type of change

  • Bug fix
  • New feature
  • Documentation
  • Maintenance / refactor

Testing

  • Tested locally: every changed claim was verified against .venv/bin/apm <cmd> --help, the source under src/apm_cli/, or a scratch-directory run. cd docs && npm run build exits 0 ("All internal links are valid"; "Checked 1197 relative link(s) ... No broken relative links found").
  • All existing tests pass (docs-only change)
  • Added tests for new functionality (if applicable)

Spec conformance (OpenAPM v0.1)

  • N/A -- this PR does not change OpenAPM-observable behaviour.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are recorded for this documentation-only update to the integration guides.

No open issues 🎉

What changed in this PR

This docs-only PR updates six integration guides to reflect current APM behavior, contributing a focused batch of corrections to the documentation re-sweep in #3800.

Changes:

  • Corrects target removal instructions, expands target capabilities and MCP paths, and repairs a manifest link.
  • Clarifies Copilot App warnings and uninstall behavior, plus Cowork’s per-skill deployment path.
  • Updates the required audit check name, Python prerequisite, deployed-file commit guidance, and runtime registration instructions.
File Description
docs/​src/​content/​docs/​integrations/​runtime-compatibility.md Replaces separate registration steps with the shared RuntimeDescriptor registry.
docs/​src/​content/​docs/​integrations/​ide-tool-integration.md Corrects target cleanup, adds capability and MCP details, and fixes the manifest anchor.
docs/​src/​content/​docs/​integrations/​github-rulesets.md Changes the required status check from APM Audit to audit.
docs/​src/​content/​docs/​integrations/​copilot-cowork.md Corrects the deployment directory placeholder to <skill-name>.
docs/​src/​content/​docs/​integrations/​copilot-app.md Documents skipped prompts, the full global warning, and tracked-row deletion through uninstall.
docs/​src/​content/​docs/​integrations/​ci-cd.md Specifies Python 3.11+ and includes .agents/ among deployed files to commit.

Review effort: Balanced

Surgical fixes from the post-0.36 docs corpus re-sweep. Every changed
claim was checked against current main (CLI --help, source, or a
scratch-dir run). Pages that a still-open PR edits are left out, per
the approved scope.

Refs #3800

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@danielmeppiel
Daniel Meppiel (danielmeppiel) merged commit 51820f7 into main Nov 18, 2026
26 checks passed
@danielmeppiel
Daniel Meppiel (danielmeppiel) deleted the docs-sweep/integrations branch November 18, 2026 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants