feat: bundle versioned AI guidance with WebUI - #522
Merged
Mohamed Mansour (mohamedmansour) merged 2 commits intoSep 9, 2026
Merged
feat: bundle versioned AI guidance with WebUI#522Mohamed Mansour (mohamedmansour) merged 2 commits into
Mohamed Mansour (mohamedmansour) merged 2 commits into
Conversation
Ship the canonical AI reference in the npm package and replace the installed snapshot with a minimal loader. Refresh the reference during build and packing, document one-time migration, and remove FAST-specific guidance from the AI reference. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 45307125-be11-46be-b3fe-b77df2bd3bcf
Keep ordinary dependency builds free of AI reference writes so parallel example builds cannot collide on Windows. Preserve prepack generation and add a regression guard for build lifecycle hooks. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 45307125-be11-46be-b3fe-b77df2bd3bcf
Mohamed Mansour (mohamedmansour)
requested review from
Bang Lee (Qusic),
atul (atulkatti) and
mcritzjam
September 9, 2026 00:59
Bang Lee (Qusic)
approved these changes
Sep 9, 2026
Mohamed Mansour (mohamedmansour)
deleted the
mohamedmansour-skills-documentation-setup
branch
September 9, 2026 01:08
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.
Why
Installing the full AI reference as a skill creates a separate snapshot that developers must refresh whenever WebUI changes. Bundle the reference with the npm package instead so guidance follows the application's installed version.
Approach
docs/ai.mdas the canonical reference and preserve the/aidocumentation URL.@microsoft/webuiduring prepack, include it in the tarball, and expose the./ai.mdsubpath. The generated copy is not tracked in Git. Ordinary dependency builds do not write it, avoiding the Windows file-lock race caused by parallel example builds.node_modules/@microsoft/webui/ai.md, reread after upgrades, and report missing guidance. No Node.js or package-manager loading commands are prescribed.Migration
Existing users run
npx skills add microsoft/webui --skill webui-referenceonce more to replace their snapshot with the loader. Future reference updates arrive with package upgrades. Installing the published package does not regenerate documentation or modify agent configuration; an active agent session still needs to reread after an upgrade.Validation
cargo xtask checkpassed, including the parallel example builds and documentation build.pnpm --dir packages/webui test: 72 tests passed, including a build-hook regression guard, reference refresh, missing-source failure, and app-local/hoisted resolution coverage.EBUSYdestination-lock simulation. Native Windows confirmation is delegated to the CI rerun.pnpm packand offlinenpm installcommands to verify byte-for-byte reference inclusion, then installed a synthetic newer package and confirmed the reference changed while the installed loader's SHA-256 remained identical. Rechecked tarball contents after making generation prepack-only. No package was published.