docs: add Copilot instructions and v2→v3 migration prompt for plugin developers#1392
Closed
docs: add Copilot instructions and v2→v3 migration prompt for plugin developers#1392
Conversation
Copilot
AI
changed the title
[WIP] Improve documentation for docfx and migration prompts
docs: add Copilot instructions and v2→v3 migration prompt for plugin developers
Mar 3, 2026
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.
Adds Copilot-ready developer resources targeting plugin authors consuming the Essentials framework — not framework contributors (separate issue).
Changes
.github/copilot-instructions.md— Plugin-scoped Copilot instructions covering factory/device/properties class structure,EssentialsDevicevsEssentialsBridgeableDevice, feedback pattern,CommFactoryinjection, SIMPL bridging, JSON config conventions, and naming rules. Links to hosted docs..github/prompts/migrate-plugin-v2-to-v3.prompt.md— Reusable Copilot prompt that drives migration from the deprecated v2 pattern (static LoadPlugin()/IBridge) to v3 (EssentialsPluginDeviceFactory<T>/EssentialsBridgeableDevice). Includes side-by-side before/after snippets for factory creation, device base class, bridge signature, and properties extraction, plus a completion checklist.v2 → v3 at a glance
static void LoadPlugin()on device classEssentialsPluginDeviceFactory<T>subclassDeviceFactory.AddFactoryForType(name, fn)TypeNameslist on factoryIBridge+LinkToApi(BasicTriList, uint, string)EssentialsBridgeableDevice+LinkToApi(…, EiscApiAdvanced)static stringon device class🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.