docs: Wire HelpLinkUri and expand migration documentation#18
Merged
Conversation
Set `helpLinkUri` on `Rules.SystemIOAbstractionsRule` to the package's docs URL so IDE "Show help" actions land on a useful page. The URL matches the `PackageProjectUrl` already declared in `Source/Directory.Build.props`. Expand the README to document the dev-only meta-package workflow (install → migrate → uninstall) and the explicit requirement to reference `Testably.Abstractions.Testing` directly so migrated tests keep compiling after the migration package is removed. Add tables covering the supported automatic rewrites and the manual-review patterns flagged by `TestablyM001`. The README is the docs source: the release pipeline copies it into the package and the `notify-docs-site` workflow rebuilds the docs site from it. Add `Docs/pages/00-index.md` so the Testably docs site has an entry page that templates the README, mirroring the convention used by `Mockolate.Migration`. Tests unchanged: 114 main + 40 playground + 2 example = 156.
Switch the `PackageProjectUrl` and `HelpLinkUri` from `docs.testably.org/Testably.Abstractions/Migration` to `docs.testably.org/Abstractions/Migration` to match how the docs site actually serves Testably.Abstractions content: every slice in `Testably.Site/Pipeline/Build.Pages.cs` lands under a target subdirectory without the `Testably.` prefix (`Abstractions`, not `Testably.Abstractions`). A companion change in Testably.Site adds the migration repo as a slice at `docs/Abstractions/Migration` with `InlineReadme: true`, which inlines the README into the `Docs/pages/00-index.md` placeholder added in Phase 5.6. Bump `peter-evans/repository-dispatch` in `notify-docs-site.yml` from v3 to v4 to align with sibling repos (Mockolate.Migration) so the docs rebuild dispatch uses the same action version everywhere.
|
There was a problem hiding this comment.
Pull request overview
This PR improves the migration tool’s developer experience by wiring analyzer diagnostics to the hosted migration documentation and expanding/structuring the migration docs for clearer guidance.
Changes:
- Add
helpLinkUrito the analyzer diagnostic descriptor to point users to the migration docs. - Expand
README.mdwith a recommended workflow, supported migrations, and a manual-review list. - Align docs URLs and add a docs landing page; bump docs-site notification workflow dependency.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
Source/Testably.Abstractions.Migration.Analyzers/Rules.cs |
Adds a documentation base URL and wires it into DiagnosticDescriptor.helpLinkUri. |
Source/Directory.Build.props |
Updates PackageProjectUrl to the new docs location. |
README.md |
Significantly expands migration guidance, supported patterns, and suppression instructions. |
Docs/pages/00-index.md |
Adds a docs landing page that pulls in the README content. |
.github/workflows/notify-docs-site.yml |
Updates peter-evans/repository-dispatch from v3 to v4. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This pull request introduces documentation and usability improvements for the migration analyzer package, clarifies installation and workflow, and updates links to the new documentation site. The most important changes are grouped below.
Documentation and User Guidance Improvements:
README.mdwith a detailed migration workflow, explicit instructions for referencing both the migration and target packages, and tables outlining supported and manual-review migration patterns. Added sections on suppressing diagnostics and clarified that the migration package is a development-only tool.00-index.md) for the migration package, including a NuGet badge and a summary of its purpose.Links and Metadata Updates:
Abstractions/Migration) instead of the old one (Testably.Abstractions/Migration) in both MSBuild properties and analyzer help links.CI/CD Workflow Maintenance:
peter-evans/repository-dispatch@v4for dispatching documentation update events, ensuring continued compatibility and support.