[docs] Update documentation for features from 2026-04-11#674
Open
danielmeppiel wants to merge 1 commit intomainfrom
Open
[docs] Update documentation for features from 2026-04-11#674danielmeppiel wants to merge 1 commit intomainfrom
danielmeppiel wants to merge 1 commit intomainfrom
Conversation
… .github/ layouts during compile Update the compilation guide's 'How It Works' section to explicitly document that apm compile scans each installed package for primitives in both .apm/instructions/ and .github/instructions/ (and other subdirs), so package authors know both layouts are supported. Triggered by #642 fix: apm compile --target claude was silently skipping dependency instructions stored in .github/instructions/ before this PR. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
danielmeppiel
added
automation
documentation
danielmeppiel
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the compilation guide to reflect the recent fix that apm compile discovers dependency-provided instructions stored under either .apm/ or .github/ layouts when scanning apm_modules/.
Changes:
- Clarifies that dependency packages are scanned for primitives under both
.apm/and.github/directory layouts during compile-time dependency merging.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/guides/compilation.md | Updates the “How It Works” section to explicitly mention scanning dependency packages for both .apm/ and .github/ instruction layouts. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 1
|
|
||
| 1. **Primitives Discovery**: Scans `.apm/` and `.github/` directories for instructions, prompts, and agents | ||
| 2. **Dependency Merging**: Incorporates primitives from installed packages in `apm_modules/` | ||
| 2. **Dependency Merging**: Incorporates primitives from installed packages in `apm_modules/`; each package is scanned for both `.apm/` and `.github/` layouts (e.g. `.apm/instructions/` and `.github/instructions/` are both discovered) |
There was a problem hiding this comment.
This step says "Incorporates primitives" but this page later notes that apm compile outputs (and therefore effectively merges) instructions only (prompts/agents are handled by apm install). To avoid confusion, consider changing "primitives" here to "instructions" (or "instruction primitives") while keeping the .apm/ vs .github/ layout clarification.
Suggested change
| 2. **Dependency Merging**: Incorporates primitives from installed packages in `apm_modules/`; each package is scanned for both `.apm/` and `.github/` layouts (e.g. `.apm/instructions/` and `.github/instructions/` are both discovered) | |
| 2. **Dependency Merging**: Incorporates instructions from installed packages in `apm_modules/`; each package is scanned for both `.apm/` and `.github/` layouts (e.g. `.apm/instructions/` and `.github/instructions/` are both discovered) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Updates - 2026-04-11
This PR updates the documentation based on changes merged in the last 24 hours.
Features Documented
apm compilescans dependency packages for both.apm/and.github/primitive layouts (from [fix] include dependency instructions in claude compile (#631) #642)Changes Made
docs/src/content/docs/guides/compilation.md— clarified "How It Works" step 2 to explicitly state that each installed package is scanned for primitives in both.apm/instructions/and.github/instructions/(and equivalent subdirs)Merged PRs Referenced
[fix] include dependency instructions in claude compile— fixed silent skipping of dependency instructions stored in.github/instructions/when runningapm compile --target claudewithout--local-onlyNotes
The change is a one-line documentation clarification. No new features were added; the underlying fix was behavioral (bug fix). Package authors who store instructions under
.github/instructions/in their packages can now rely on those instructions being picked up byapm compilewith dependencies, and the docs now reflect this.