docs: update all doc pages to reflect full Cursor native support#304
docs: update all doc pages to reflect full Cursor native support#304danielmeppiel merged 3 commits intomainfrom
Conversation
Add .cursor/ to directory tree example, file deployment description, editor pickup list, commit guidance, and sync tip. Remove Cursor from the compile-only note since it now has full native install support. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Update 8 doc pages that still described Cursor as compile-only or omitted .cursor/ from path lists: - first-package.md: Cursor no longer needs apm compile - why-apm.md: Cursor moved from 'bridges other tools' to native - ci-cd.md: drift checks include .cursor/, compile comments updated - github-rulesets.md: Cursor removed from compile-only category - security.md: .cursor/ added to deploy path allowlists and FAQ - compilation.md: .cursor/ in folder tree, Cursor in native list - pack-distribute.md: cursor target option, .cursor/ in bundle tree - cli-commands.md: Cursor integration detection, uninstall table Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the Starlight documentation to reflect Cursor as a native APM integration target (via .cursor/), removing prior “compile-only” references and expanding path listings and CI guidance accordingly.
Changes:
- Update getting-started and conceptual docs to describe Cursor as a native integration target alongside Copilot and Claude.
- Update CI/CD and ruleset docs to adjust when
apm compileis needed and to include.cursor/in drift-check guidance. - Update reference docs to mention Cursor integration auto-detection and uninstall cleanup paths.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/reference/cli-commands.md | Adds Cursor auto-detection note and Cursor uninstall cleanup entries. |
| docs/src/content/docs/introduction/why-apm.md | Reframes Cursor as native integration (not “bridge/compile-only”). |
| docs/src/content/docs/integrations/github-rulesets.md | Removes Cursor from “compile-only” guidance in CI examples. |
| docs/src/content/docs/integrations/ci-cd.md | Updates compile notes and adds .cursor/ to drift-check snippet. |
| docs/src/content/docs/guides/pack-distribute.md | Adds Cursor to apm pack target/filter docs and bundle tree examples. |
| docs/src/content/docs/guides/compilation.md | Adds .cursor/ to folder tree and install-vs-compile explanatory note. |
| docs/src/content/docs/getting-started/quick-start.md | Adds .cursor/ to example output and workflow guidance. |
| docs/src/content/docs/getting-started/first-package.md | Updates compile guidance to exclude Cursor from needing apm compile. |
| docs/src/content/docs/enterprise/security.md | Adds .cursor/ to the documented deploy-prefix allowlist and FAQ. |
Comments suppressed due to low confidence (4)
docs/src/content/docs/guides/pack-distribute.md:80
- The target filtering table includes
cursorand saysallincludes.cursor/, but the currentapm packimplementation’s filter prefixes forallare.github/+.claude/only (no.cursor/). This section should be updated to match current behavior, or the packer updated to support Cursor prefixes.
The target flag controls which deployed files are included based on path prefix:
| Target | Includes |
|--------|----------|
| `copilot` | Paths starting with `.github/` |
| `vscode` | Alias for `copilot` |
| `claude` | Paths starting with `.claude/` |
| `cursor` | Paths starting with `.cursor/` |
| `all` | `.github/`, `.claude/`, and `.cursor/` |
docs/src/content/docs/getting-started/quick-start.md:96
- This summary says “Instructions, prompts, and skills were deployed to
.github/,.claude/, and.cursor/”, but prompts are only deployed to.github/prompts/(and transformed into Claude commands under.claude/commands/). There’s no prompt deployment target under.cursor/in the current integrators, so this statement is inaccurate.
1. The package was downloaded into `apm_modules/` (like `node_modules/`).
2. Instructions, prompts, and skills were deployed to `.github/`, `.claude/`, and `.cursor/` -- the native directories that GitHub Copilot, Claude, and Cursor already read from.
3. A lockfile (`apm.lock.yaml`) was created, pinning the exact commit so every team member gets identical configuration.
docs/src/content/docs/guides/pack-distribute.md:137
- The “All targets” bundle structure example includes a
.cursor/subtree. Today,apm packcannot include.cursor/deployed files because target filtering doesn’t include.cursor/prefixes. Either adjust this example or add Cursor support to the packer so this output is achievable.
### All targets
build/my-project-1.0.0/
.github/
prompts/
...
agents/
...
.claude/
commands/
...
.cursor/
rules/
...
agents/
...
apm.lock.yaml
**docs/src/content/docs/getting-started/quick-start.md:110**
* By mentioning Cursor here alongside Copilot/Claude, this implies Cursor can “run your prompt templates” out of the box. Currently APM deploys prompts to `.github/prompts/` (and Claude commands to `.claude/commands/`), but does not deploy prompts into a Cursor-native location. Consider rephrasing to avoid implying Cursor consumes `.prompt.md` templates natively.
Open your editor. GitHub Copilot, Claude, and Cursor pick up the new context immediately -- no extra configuration, no compile step, no restart. The agent now knows your project's design standards, can run your prompt templates, and follows the conventions defined in the package.
</details>
| run: | | ||
| apm install | ||
| if [ -n "$(git status --porcelain -- .github/ .claude/)" ]; then | ||
| if [ -n "$(git status --porcelain -- .github/ .claude/ .cursor/)" ]; then |
| | Flag | Default | Description | | ||
| |------|---------|-------------| | ||
| | `--format` | `apm` | Bundle format (`apm` or `plugin`) | | ||
| | `-t, --target` | auto-detect | File filter: `copilot`, `vscode`, `claude`, `all`. `vscode` is an alias for `copilot` | | ||
| | `-t, --target` | auto-detect | File filter: `copilot`, `vscode`, `claude`, `cursor`, `all`. `vscode` is an alias for `copilot` | | ||
| | `--archive` | off | Produce `.tar.gz` instead of directory | |
…racy - Add cursor target to apm pack (packer.py + pack.py Click.Choice) - Fix docs claiming prompts deploy to .cursor/ (they don't) - Clarify .cursor/ is opt-in in quick-start tree example - Note .cursor/ integration requires existing directory Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Addressed both unresolved review comments in 89c9960: pack-distribute.md ( ci-cd.md ( Also fixed accuracy issues caught by resolved comments: "prompts" → "primitives" in cli-commands.md, removed prompt-specific All 1758 tests passing. |
Summary
Follow-up to #301 — updates 9 doc pages that still described Cursor as compile-only or omitted
.cursor/from path listings.Changes
quick-start.md.cursor/in directory tree, deployment description, editor list, commit guidance; removed Cursor from compile-only notefirst-package.mdapm compilewhy-apm.mdci-cd.md.cursor/; compile comments updated (4 places)github-rulesets.mdsecurity.md.cursor/added to deploy path allowlists and FAQ (3 places)compilation.md.cursor/in folder tree; Cursor in native tools list (3 places)pack-distribute.mdcursortarget option;.cursor/in bundle tree (3 places)cli-commands.mdNo code changes — docs only.