Skip to content

[docs] Update documentation for features from 2026-05-01#1095

Open
danielmeppiel wants to merge 1 commit intomainfrom
docs/daily-update-2026-05-01-36a028889ed97f2a
Open

[docs] Update documentation for features from 2026-05-01#1095
danielmeppiel wants to merge 1 commit intomainfrom
docs/daily-update-2026-05-01-36a028889ed97f2a

Conversation

@danielmeppiel
Copy link
Copy Markdown
Collaborator

Documentation Updates - 2026-05-01

This PR updates the documentation based on features merged in the last 24 hours.

Features Documented

Changes Made

  • Updated docs/src/content/docs/guides/compilation.md:
    • Target auto-detection table: copilot row now shows both AGENTS.md and .github/copilot-instructions.md
    • Output Files table: updated copilot entry to include .github/copilot-instructions.md
    • Added explanatory note: global instructions (no applyTo) go to .github/copilot-instructions.md; per-pattern instructions continue to flow into .github/instructions/*.instructions.md; generated files carry a build-id marker for safe cleanup
    • Example Output: updated the example directory tree to show the new file
    • Tool Compatibility table: updated GitHub Copilot row to reflect new compile output

Merged PRs Referenced

Notes

The marketplace-authoring.md guide was already up to date with the new fields added in #1063 (author, license, repository, keywords, pluginRoot subtraction, curator-wins override semantics). No changes were needed there.

Note

🔒 Integrity filter blocked 13 items

The following items were blocked because they don't meet the GitHub integrity level.

  • #1084 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #1055 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #1052 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #1048 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #1034 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #1024 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #991 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #959 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #951 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #947 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #941 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #937 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #871 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".

To allow these resources, lower min-integrity in your GitHub frontmatter:

tools:
  github:
    min-integrity: approved  # merged | approved | unapproved | none

Generated by Daily Documentation Updater · ● 1.4M ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/daily-doc-updater.md@b87234850bf9664d198f28a02df0f937d0447295
  • expires on May 3, 2026, 12:56 PM UTC

… compile

apm compile -t copilot now synthesizes .github/copilot-instructions.md
from global (no applyTo) instructions in .apm/instructions/. Update:
- Target auto-detection table
- Output Files table and notes
- Example Output section
- Tool Compatibility table

Closes reference to #1067.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 1, 2026 12:57
@danielmeppiel danielmeppiel added automation Deprecated: use type/automation. Kept for issue history; will be removed in milestone 0.10.0. documentation Deprecated: use type/docs. Kept for issue history; will be removed in milestone 0.10.0. labels May 1, 2026
Copy link
Copy Markdown
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

Updates the Starlight compilation guide to reflect the recently-merged change where apm compile -t copilot can emit .github/copilot-instructions.md from global (no-applyTo) instructions, aligning docs with current Copilot compilation behavior.

Changes:

  • Update target auto-detection + output tables to include .github/copilot-instructions.md for the copilot target.
  • Add a note explaining how global vs per-pattern instructions are routed for Copilot and how generated files are safely cleaned up.
  • Update the example output tree and the tool compatibility table to mention the new file.
Show a summary per file
File Description
docs/src/content/docs/guides/compilation.md Documents Copilot root instructions emission (.github/copilot-instructions.md) as part of apm compile output.

Copilot's findings

  • Files reviewed: 1/1 changed files
  • Comments generated: 2

├── AGENTS.md # Instructions only (for Copilot, Cursor, etc.)
└── CLAUDE.md # Instructions only (for Claude)
├── AGENTS.md # Instructions (for Copilot, Cursor, etc.)
├── CLAUDE.md # Instructions (for Claude)
Copy link

Copilot AI May 1, 2026

Choose a reason for hiding this comment

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

The example is labeled as a copilot-target compile, but it shows CLAUDE.md being generated as well. CLAUDE.md is only produced when the target includes claude (or auto-detection resolves to all). Please either remove CLAUDE.md from this tree or change the caption to reflect a multi-target/all compile.

Suggested change
├── CLAUDE.md # Instructions (for Claude)

Copilot uses AI. Check for mistakes.
Comment on lines 54 to +66
@@ -62,6 +62,8 @@ target: [claude, copilot] # multiple targets -- only these are compiled

> **Aliases**: `vscode` and `agents` are accepted as aliases for `copilot`.

> **Note**: For the `copilot` target, instructions without an `applyTo` pattern (global instructions) are also synthesized into `.github/copilot-instructions.md`. Instructions with `applyTo` patterns continue to flow into per-pattern `.github/instructions/*.instructions.md` files. The generated `.github/copilot-instructions.md` carries a build-id marker so `apm compile` can cleanly remove it when switching to a non-Copilot target -- manually-authored files at the same path are preserved.

Copy link

Copilot AI May 1, 2026

Choose a reason for hiding this comment

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

The tables/readme-style text imply .github/copilot-instructions.md is always generated for the copilot target, but the compiler only writes it when there is at least one global instruction (no applyTo); otherwise it will remove a previously-generated file. Consider annotating the table entry (and/or the note) with this condition so users don't expect the file to appear in projects that only use per-pattern instructions.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation Deprecated: use type/automation. Kept for issue history; will be removed in milestone 0.10.0. documentation Deprecated: use type/docs. Kept for issue history; will be removed in milestone 0.10.0.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants