feat: aggregate Testably.Abstractions.Migration into docs site#41
Merged
Conversation
Add the migration package's documentation as a separate slice under
`docs/Abstractions/Migration/`, matching the `PackageProjectUrl` of
`docs.testably.org/Abstractions/Migration`. The migration repo ships
its content as a `Docs/pages/00-index.md` with `{README}` placeholder,
so it slots into the existing `InlineReadme: true` flow.
Placed immediately after the `Testably.Abstractions` slice so its
clean-and-populate pass on `docs/Abstractions/` runs before this slice
creates `docs/Abstractions/Migration/`; otherwise the parent's clean
would wipe the subdirectory.
Other migration packages (aweXpect.Migration, Mockolate.Migration)
follow the `ExtraReadmes` convention where the parent library owns
a placeholder page. Using a separate slice here keeps the change
self-contained to this repo, since the upstream Testably.Abstractions
docs do not yet expose a placeholder file.
There was a problem hiding this comment.
Pull request overview
Adds Testably.Abstractions.Migration as a separate aggregated documentation slice under the existing Abstractions docs area, with local mirroring updated to match the new source.
Changes:
- Adds
Testably.Abstractions.Migrationto the docs aggregation source list. - Updates the local docs mirroring script with the new source.
- Reads mirrored text files explicitly as UTF-8.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
Pipeline/Build.Pages.cs |
Adds the migration docs source to the aggregation pipeline. |
Docs/mirror-local-docs.ps1 |
Mirrors the new migration docs source locally and uses UTF-8 reads. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The previous commit referenced Title: and SidebarPosition: named arguments on DocsSource that were never added to the record, so the Pipeline project did not compile. Drop them — the upstream Testably.Abstractions.Migration index page now carries the title and sidebar position in its own frontmatter, which the pipeline's EnsureSidebarPosition logic already preserves. Also retarget the slice from Abstractions/Migration to Abstractions/migration-from-testableio/Migration so the package's docs nest under the existing "Migration from TestableIO" guide. Requires the upstream Testably.Abstractions repo to ship migration-from-testableio as a directory (with index.mdx) rather than a flat page. Mirror the slice change in mirror-local-docs.ps1.
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.
Add the migration package's documentation as a separate slice under
docs/Abstractions/Migration/, matching thePackageProjectUrlofdocs.testably.org/Abstractions/Migration. The migration repo ships its content as aDocs/pages/00-index.mdwith{README}placeholder, so it slots into the existingInlineReadme: trueflow.Placed immediately after the
Testably.Abstractionsslice so its clean-and-populate pass ondocs/Abstractions/runs before this slice createsdocs/Abstractions/Migration/; otherwise the parent's clean would wipe the subdirectory.Other migration packages (aweXpect.Migration, Mockolate.Migration) follow the
ExtraReadmesconvention where the parent library owns a placeholder page. Using a separate slice here keeps the change self-contained to this repo, since the upstream Testably.Abstractions docs do not yet expose a placeholder file.