Repository navigation
docs: add a no-install prompt for the AI skill - #1488
Conversation
Document a copyable prompt that shallow-clones one commit and only the skills/easy-yapi-assistant folder, for assistants without skill support or users who do not want a global install. Refs #1487
|
📦 Plugin has been packaged for this PR. You can download it from the GitHub Actions workflow run by clicking on the "Artifacts" dropdown:
Each artifact is a ready-to-install plugin zip — pick the one matching your IDEA version and install it via Settings → Plugins → ⚙ → Install Plugin from Disk. No extraction needed. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1488 +/- ##
=========================================
Coverage 69.940% 69.940%
=========================================
Files 518 518
Lines 30383 30383
Branches 7147 7147
=========================================
Hits 21250 21250
Misses 6374 6374
Partials 2759 2759
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
Description
Add a "Use the skill without installing" section to both READMEs. It gives users a copyable prompt that shallow-clones only the
skills/easy-yapi-assistant/folder, so an AI assistant can temporarily follow the skill withoutnpx skills add.Type of Change
Related Issues
Refs #1487
Affected Area
Changes Made
README.md.README_CN.md.How I Tested
Docs-only change; no code paths were modified, so
./gradlew testwas not run../gradlew testpasses./gradlew runIde) — describe the entry action exercised(e.g. "Right-click a Spring controller → EasyYapi → ExportMarkdown, checked the generated markdown")
Architecture & Threading Checklist
N/A — documentation only, no code, PSI, threading, or logging changes.
channel//format//framework//core/per the Package Layout rule in AGENTS.md); nocore.*→ concrete sibling importsread {}/readSync {}— or documented with@requires ReadActionand all callers are internal (never on a boundary class)toString()/hashCode()/equalsand reachableby lazyinitializerswrite {}/swing {}; never bypassedlaunch(Dispatchers.Default)from EDT / startup contexts — background work usesbackgroundAsync/IdeDispatchers.BackgroundLogging Checklist
N/A — documentation only, no logging changes.
NotificationUtils/IdeaConsole/IdeaLog, first-match-wins) — noconsole.error+LOG.errorornotifyError+LOG.errorpairingLOG.error,LOG.debug,LOG.trace,println, orprintStackTrace()in production code (LOG.infois the floor)runCatching{}.getOrNull()or emptycatchon meaningful operationsGeneral Checklist
Docs-only; the unchecked items above do not apply.
Screenshots (if applicable)
N/A
Additional Notes
The prompt uses
--depth 1 --single-branch --filter=blob:none --sparseand thensparse-checkout set skills/easy-yapi-assistant, so it fetches one commit and only the skill folder. Users can replacemasterwith a release tag to match their installed plugin version.