Repository navigation
docs: keep the README separate from the docs page in Mockolate - #106
Merged
Merged
Conversation
vbreuss
enabled auto-merge (squash)
October 31, 2026 09:24
The docs site no longer copies this README into the Mockolate docs, whose automated migration page is now maintained there, so the unused template page goes. The README links the right repository and names the mock as the Mockolate docs do, and the package project URL points to the existing page.
Keeping the page in the Mockolate repository meant a second pull request for every change of the migration package. The docs site publishes it in the Mockolate migration section.
The README already lists this case since #96, and the docs page should describe the same behavior.
vbreuss
force-pushed
the
docs/shared-install-section
branch
from
October 31, 2026 10:24
4cd0628 to
3071c68
Compare
|
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 updates the documentation to clarify how migration documentation is maintained and improves the organization and content of the migration docs. The main changes include separating the user documentation from the docs site, creating a dedicated migration page with comprehensive migration instructions and translation tables, and making minor corrections and clarifications in the
README.md.Documentation structure and publishing:
AGENTS.mdandDocs/agents/workflows.mdto clarify that migration tables are now maintained both inREADME.mdand in a dedicated docs site page (Docs/pages/11-migration.md), and to explain the publishing flow for user and author documentation.Migration documentation improvements:
Docs/pages/11-migration.md, including installation instructions, migration steps for Moq and NSubstitute, translation tables, and a section on what requires manual review. This page is now the primary reference for migration on the docs site.{README}embedding fromDocs/pages/00-index.md, decoupling the docs site index from theREADME.md.README and minor content fixes:
README.mdto reference the correct Mockolate repository, clarify package usage, and improve example code consistency.