Repository navigation
docs: apply the docs style guide - #110
Merged
Merged
Conversation
Aligns the automated migration docs with the shared docs style guide of docs.testably.org and makes the per-library details easier to find. - The single `11-migration.md` page is split into a `01-automated/` folder: an overview (installation, applying the fixes, manual review) and one page each for Moq and NSubstitute. They are served at /Mockolate/migration/automated/ (/moq, /nsubstitute), so the `slug` is no longer needed and `PackageProjectUrl` gets the trailing slash. - Every page has a `description` and an H1, installation uses `<PackageInstall>` under `## Installation`, and the relative links into the Mockolate docs follow its new `NN-` folder names one level deeper. - The README links to the docs page. - AGENTS.md gets the guide's short rules in a `## Documentation` section, and the agent docs point to the new pages and explain how their links resolve on the site.
|
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.
Aligns the automated migration docs with the shared docs style guide of docs.testably.org and makes the per-library details easier to find.
11-migration.mdpage is split into a01-automated/folder: an overview (installation, applying the fixes, manual review) and one page each for Moq and NSubstitute. They are served at /Mockolate/migration/automated/ (/moq, /nsubstitute), so theslugis no longer needed andPackageProjectUrlgets the trailing slash.descriptionand an H1, installation uses<PackageInstall>under## Installation, and the relative links into the Mockolate docs follow its newNN-folder names one level deeper.## Documentationsection, and the agent docs point to the new pages and explain how their links resolve on the site.