Conversation
…cussion FAQ Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
pelikhan
approved these changes
Apr 1, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the reference FAQ to reduce duplication and improve readability by consolidating repeated guidance and condensing verbose troubleshooting bullets.
Changes:
- Removed duplicated Claude plugin + APM dependencies content, keeping only Claude-specific details and linking to the canonical dependencies reference.
- Condensed the
create-discussiontroubleshooting bullets into shorter prose while retaining the key checks and fallback guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| APM automatically infers the `claude` engine target and unpacks only Claude-compatible primitives. You can mix plugins with other APM primitives in the same `dependencies:` block, and APM resolves the full dependency tree including transitive dependencies. | ||
|
|
||
| For version-pinned plugins: | ||
| Yes! APM supports Claude plugins in the `plugin.json` format. When `engine: claude` is set, APM automatically infers the engine target and unpacks only Claude-compatible primitives. Use `#tag` or `#branch` suffixes to pin specific versions: |
There was a problem hiding this comment.
For consistency with the APM Dependencies reference (which describes pinning as owner/repo#ref where ref can be a tag/branch/SHA), consider rephrasing "Use #tag or #branch suffixes" to avoid implying that #tag/#branch are literal suffixes readers should type.
Suggested change
| Yes! APM supports Claude plugins in the `plugin.json` format. When `engine: claude` is set, APM automatically infers the engine target and unpacks only Claude-compatible primitives. Use `#tag` or `#branch` suffixes to pin specific versions: | |
| Yes! APM supports Claude plugins in the `plugin.json` format. When `engine: claude` is set, APM automatically infers the engine target and unpacks only Claude-compatible primitives. Use the `owner/repo#ref` form, where `ref` is a tag or branch, to pin specific versions: |
| - **Category slugs**: Use lowercase category slugs (e.g., `general`, `announcements`) rather than display names for better reliability. | ||
| - **Discussions not enabled**: Ensure discussions are enabled for your repository in **Settings → Features → Discussions**. | ||
| - **Insufficient permissions**: The workflow requires `discussions: write` permission. | ||
| Ensure discussions are enabled (**Settings → Features → Discussions**) and the workflow has `discussions: write` permission. For category matching failures, verify spelling (case-insensitive) and use lowercase slugs (e.g., `general`, `announcements`) rather than display names. |
There was a problem hiding this comment.
The parenthetical "verify spelling (case-insensitive)" is a bit ambiguous (spelling itself isn't case-insensitive). Consider wording this as "verify spelling; category matching is case-insensitive" to keep the guidance clear.
Suggested change
| Ensure discussions are enabled (**Settings → Features → Discussions**) and the workflow has `discussions: write` permission. For category matching failures, verify spelling (case-insensitive) and use lowercase slugs (e.g., `general`, `announcements`) rather than display names. | |
| Ensure discussions are enabled (**Settings → Features → Discussions**) and the workflow has `discussions: write` permission. For category matching failures, verify spelling; category matching is case-insensitive, and use lowercase slugs (e.g., `general`, `announcements`) rather than display names. |
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.
Improved
docs/src/content/docs/reference/faq.mdby removing duplicate content and condensing verbose bullet lists.Changes made
File:
docs/src/content/docs/reference/faq.md1. Removed duplicate Claude plugins section (−26 lines)
The "Can I use Claude plugins with APM dependencies?" section (38 lines) largely repeated the preceding "The
plugins:field I was using is gone" section. Both showed the same basicdependencies:example and the same cross-orggithub-app:authentication block. The revised section keeps only the unique content — engine target auto-inference and version pinning syntax — and refers readers to APM Dependencies for private-package setup already covered above.2. Condensed create-discussion issue bullets to prose (−4 lines, −4 bullet points)
Four bullets under "Why is my create-discussion workflow failing?" were converted to two concise prose sentences without losing any information. The
fallback-to-issuehint was folded into a single follow-up sentence.Metrics
Screenshots
Visual screenshots were unavailable during this run: the Playwright container could not reach the Astro dev server (network isolation between containers). Page content was verified via
curl— both edited sections rendered correctly with the expected condensed text.References: §23830946750