Skip to content

docs: add a no-install prompt for the AI skill - #1488

Merged
tangcent merged 1 commit into
masterfrom
docs/skill-without-install
Nov 4, 2026
Merged

tangcent merged 1 commit into
masterfrom
docs/skill-without-install

Conversation

@tangcent

Copy link
Copy Markdown
Owner

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 without npx skills add.

Type of Change

  • Documentation update

Related Issues

Refs #1487

Affected Area

  • Other / not user-facing

Changes Made

  • Added a copyable no-install prompt to README.md.
  • Added the equivalent section to README_CN.md.

How I Tested

Docs-only change; no code paths were modified, so ./gradlew test was not run.

  • ./gradlew test passes
  • Manual verification in a sandbox IDE (./gradlew runIde) — describe the entry action exercised
    (e.g. "Right-click a Spring controller → EasyYapi → ExportMarkdown, checked the generated markdown")
  • New tests added for new functionality

Architecture & Threading Checklist

N/A — documentation only, no code, PSI, threading, or logging changes.

  • New code lives in the right bucket (channel/ / format/ / framework/ / core/ per the Package Layout rule in AGENTS.md); no core.* → concrete sibling imports
  • PSI/VFS reads wrapped in read {} / readSync {} — or documented with @requires ReadAction and all callers are internal (never on a boundary class)
  • Boundary classes (script contexts handed to Groovy, EP implementations) self-protect every public member — including implicit toString()/hashCode()/equals and reachable by lazy initializers
  • PSI writes and UI updates go through write {} / swing {}; never bypassed
  • No new launch(Dispatchers.Default) from EDT / startup contexts — background work uses backgroundAsync / IdeDispatchers.Background

Logging Checklist

N/A — documentation only, no logging changes.

  • Exactly one channel per event (NotificationUtils / IdeaConsole / IdeaLog, first-match-wins) — no console.error + LOG.error or notifyError + LOG.error pairing
  • No LOG.error, LOG.debug, LOG.trace, println, or printStackTrace() in production code (LOG.info is the floor)
  • Throwables passed as the last argument, never stringified into the message; no silent runCatching{}.getOrNull() or empty catch on meaningful operations

General Checklist

  • My code follows the project's architecture principles
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

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 --sparse and then sparse-checkout set skills/easy-yapi-assistant, so it fetches one commit and only the skill folder. Users can replace master with a release tag to match their installed plugin version.

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
@github-actions github-actions Bot added the type: doc Document task label Oct 30, 2026
@github-actions

Copy link
Copy Markdown
Contributor

📦 Plugin has been packaged for this PR. You can download it from the GitHub Actions workflow run by clicking on the "Artifacts" dropdown:

  • easy-yapi-3.2.6.252.0.zip — IntelliJ IDEA 2025.2+ (officially supported)
  • easy-yapi-3.2.6.221.251.zip — IntelliJ IDEA 2022.1 – 2025.1 (best-effort, not verified on older IDEs)

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

codecov Bot commented Oct 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.940%. Comparing base (a35bab8) to head (b201bc6).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@            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           
Flag Coverage Δ
unittests 69.940% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a35bab8...b201bc6. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tangcent
tangcent merged commit ed4bbbd into master Nov 4, 2026
14 checks passed
@tangcent
tangcent deleted the docs/skill-without-install branch November 4, 2026 23:01
@tangcent tangcent mentioned this pull request Nov 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: doc Document task

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant