docs: use real plugin ids in examples and expand troubleshooting - #1
Open
Alishahzad1903 wants to merge 1 commit into
Open
docs: use real plugin ids in examples and expand troubleshooting#1Alishahzad1903 wants to merge 1 commit into
Alishahzad1903 wants to merge 1 commit into
Conversation
The examples referenced plugin ids that do not exist in the marketplace (`discourse-api-documentation-sdk`, `acme-payments-sdk`, `my-sdk`), so copying one straight out of the README or `--help` failed. Point them at ids the registry actually serves, and lead with a generic `<plugin>` plus a pointer to `list` so discovery does not depend on the example. Also: - document `--long`, which `list` already supports - move the `doctor` section below the options and layout reference, so the command list is followed by the flags that apply to it - match the duplicate-marketplace troubleshooting row to the message text as of 2ca833c, and add rows for an unlisted plugin id and for an upstream rename breaking `update` The matching fix to the CI smoke test is on a separate branch; pushing it needs a token with the `workflow` scope. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Why
The README and
--helpexamples used plugin ids that the marketplace does not list —discourse-api-documentation-sdk,acme-payments-sdk,my-sdk. Copying any of them verbatim gets you'<plugin>' is not listed in context-plugins, which is a bad first run.What changed
paypalandacme-paymentsreplace the invented ones. The README now leads with a genericnpx context-plugins install <plugin>, showspaypalas the concrete case, and points atlistso discovery does not depend on the example staying current.--longis documented.listhas supported it since it was added (src/cli.js:14,:209,:242); it was just missing from the options table.doctorsection moved below the options table and state-directory layout, so the command list is immediately followed by the flags that apply to it.already has a marketplace named '<name>', from <other-repo>). Two new rows: an unlisted plugin id, and an upstream rename breakingupdate.Notes for the reviewer
src/cli.jstouches nothing but theExamplesblock string.context-plugins/plugin-marketplace@main, which currently lists 29 plugins includingpaypalanddiscourse-documentation.discourse-api-documentation-sdkand so cannot pass. The one-line fix is committed locally onci/real-plugin-idbut could not be pushed: the token available here has noworkflowscope, so GitHub rejects any push touching.github/workflows/. That needs pushing separately with aworkflow-scoped token.doctorsample output in this branch says16 plugins; the registry actually has 29. It is illustrative output, so I left the number as-is rather than change authored content — say the word and I will make it 29.🤖 Generated with Claude Code