Skip to content

docs: update all doc pages to reflect full Cursor native support#304

Merged
danielmeppiel merged 3 commits intomainfrom
docs/cursor-support-updates
Mar 14, 2026
Merged

docs: update all doc pages to reflect full Cursor native support#304
danielmeppiel merged 3 commits intomainfrom
docs/cursor-support-updates

Conversation

@danielmeppiel
Copy link
Collaborator

Summary

Follow-up to #301 — updates 9 doc pages that still described Cursor as compile-only or omitted .cursor/ from path listings.

Changes

File Fix
quick-start.md .cursor/ in directory tree, deployment description, editor list, commit guidance; removed Cursor from compile-only note
first-package.md Cursor no longer needs apm compile
why-apm.md Cursor moved from "bridges other tools" to native integration
ci-cd.md Drift checks include .cursor/; compile comments updated (4 places)
github-rulesets.md Cursor removed from compile-only category (2 places)
security.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.md cursor target option; .cursor/ in bundle tree (3 places)
cli-commands.md Cursor integration detection; uninstall cleanup table (3 places)

No code changes — docs only.

danielmeppiel and others added 2 commits March 14, 2026 21:50
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>
Copilot AI review requested due to automatic review settings March 14, 2026 20:50
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 compile is 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 cursor and says all includes .cursor/, but the current apm pack implementation’s filter prefixes for all are .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 pack cannot 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
Comment on lines 62 to 66
| 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>
@danielmeppiel
Copy link
Collaborator Author

Addressed both unresolved review comments in 89c9960:

pack-distribute.md (--target cursor): Added cursor support to the actual code — _TARGET_PREFIXES in packer.py now includes ".cursor/" and pack.py accepts cursor in click.Choice. This is a 2-line change that makes the docs accurate rather than reverting them. The all target also now includes .cursor/ files.

ci-cd.md (.cursor/ pathspec): Verified that git status --porcelain -- .cursor/ does NOT error when the directory doesn't exist — it returns empty output with exit code 0. This is standard git behavior for pathspecs. No code change needed, but the quick-start tree now has an inline comment clarifying .cursor/ is opt-in.

Also fixed accuracy issues caught by resolved comments: "prompts" → "primitives" in cli-commands.md, removed prompt-specific .cursor/ claims in why-apm.md.

All 1758 tests passing.

@danielmeppiel danielmeppiel merged commit f1e21e7 into main Mar 14, 2026
8 checks passed
@danielmeppiel danielmeppiel deleted the docs/cursor-support-updates branch March 14, 2026 21:17
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