Skip to content

docs(cli-reference): fix drifted flags, exit codes, anchors and sample output - #3805

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

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

Conversation

@danielmeppiel

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

Copy link
Copy Markdown
Collaborator

Description

Surgical fixes to the CLI reference pages (reference/cli/*, reference/primitive-types.md), checked against apm <cmd> --help and the click definitions on current main.

  • pack.md: a broken #36-target anchor now points to #36-target-and-targets.
  • publish.md: an unknown --registry name exits 1, not 2. Missing registries: is listed under exit 1.
  • config.md: a persisted http:// mcp-registry-url does not need MCP_REGISTRY_ALLOW_HTTP=1 (config-sourced URLs are exempt).
  • experimental.md: adds the missing grok-cloud flag. marketplace-authoring gates nothing today.
  • list.md, prune.md: apm list lists scripts. Installed packages are apm deps list / apm deps tree.
  • find.md: --source prints owner/repo@ref, not a .git URL.
  • policy.md: documents the warnings field and row.
  • plugin.md: plugin-name rule and the --format / --claude-plugin synopsis.
  • preview.md, cache.md, run.md, targets.md: sample output now matches real output (status symbols, row order, .github/mcp.json copilot signal).
  • pack.md: says "above", not "below", for the Claude plugin bundle.
  • primitive-types.md: .apm/context/ directory, owner/repo install paths, Skill.source.

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.

🟡 Changes recommended

The CLI documentation incorrectly describes targets as producing no compile output when they can fall back to minimal and generate AGENTS.md.

1 open issue
What changed in this PR

This docs-only PR updates APM's CLI and primitive references as one batch of the documentation re-sweep in #3800. It changes documentation, not runtime behavior.

Changes:

  • Corrects command flags, exit codes, configuration requirements, and feature descriptions.
  • Refreshes sample output, target information, and dependency-inspection guidance.
  • Repairs anchors and updates primitive model and directory examples.
File Description
docs/​src/​content/​docs/​reference/​primitive-types.md Adds Skill.source and corrects directory examples.
docs/​src/​content/​docs/​reference/​cli/​targets.md Updates output ordering and Copilot detection signals.
docs/​src/​content/​docs/​reference/​cli/​run.md Corrects the available-scripts status symbol.
docs/​src/​content/​docs/​reference/​cli/​publish.md Revises registry-related exit codes.
docs/​src/​content/​docs/​reference/​cli/​prune.md Links to installed dependency inspection.
docs/​src/​content/​docs/​reference/​cli/​preview.md Clarifies panels shown without prompt files.
docs/​src/​content/​docs/​reference/​cli/​policy.md Documents policy warnings and their output row.
docs/​src/​content/​docs/​reference/​cli/​plugin.md Updates format options and naming constraints.
docs/​src/​content/​docs/​reference/​cli/​pack.md Fixes an anchor and bundle cross-reference.
docs/​src/​content/​docs/​reference/​cli/​marketplace.md Documents offline mode and command-specific flags.
docs/​src/​content/​docs/​reference/​cli/​list.md Points readers to dependency list and tree commands.
docs/​src/​content/​docs/​reference/​cli/​find.md Corrects source-reference descriptions and examples.
docs/​src/​content/​docs/​reference/​cli/​experimental.md Adds Grok Cloud and clarifies marketplace flag behavior.
docs/​src/​content/​docs/​reference/​cli/​config.md Clarifies persisted HTTP registry configuration.
docs/​src/​content/​docs/​reference/​cli/​compile.md Repairs the targets anchor and expands the output table.
docs/​src/​content/​docs/​reference/​cli/​cache.md Refreshes sample output status symbols.

Review effort: Balanced

…e output

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 dc13f60 into main Nov 18, 2026
26 checks passed
@danielmeppiel
Daniel Meppiel (danielmeppiel) deleted the docs-sweep/cli-reference branch November 18, 2026 02:54
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