docs: align README, roadmap, framework wording, and AI prompt docs#144
Merged
docs: align README, roadmap, framework wording, and AI prompt docs#144
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-focused PR that refreshes FastMoq’s public-facing docs for v4 evaluation, aligns roadmap wording with the public backlog (including a new detailed generator planning page), and adds AI prompt-template documentation with navigation/publishing updates.
Changes:
- Updated top-level and docs-site navigation to surface Feature Parity and new AI prompt templates; removed the older migration-only Copilot prompt page.
- Reworked roadmap docs to separate concise roadmap notes from detailed v5 generator planning/design.
- Refined framework-neutral wording across docs and expanded the feature-parity page into a clearer comparison aid.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| toc.yml | Adds nav entries for Feature Parity, AI prompt templates, and generator roadmap; removes old Copilot prompts entry. |
| docs/roadmap/generator-roadmap.md | New detailed v5 generator roadmap/design companion page. |
| docs/roadmap/README.md | Updates roadmap framing, aligns with public backlog, and links to generator roadmap. |
| docs/migration/provider-and-compatibility.md | Refocuses provider-default guidance and routes detailed mechanics to provider-selection docs. |
| docs/migration/copilot-prompts.md | Removes the older migration-only Copilot prompt templates page. |
| docs/migration/README.md | Repoints AI-assistance entry links to the new AI prompt templates page. |
| docs/getting-started/testing-guide.md | Adds a pointer to AI prompt templates. |
| docs/getting-started/provider-selection.md | Clarifies framework-specific startup hook examples as parallel options (not product modes). |
| docs/getting-started/README.md | Adds AI prompt templates pointer and clarifies xUnit usage as example-only. |
| docs/feature-parity/README.md | Expands parity/comparison content and adds more detailed examples and guidance. |
| docs/cookbook/README.md | Clarifies xUnit usage as example-only. |
| docs/ai/README.md | New AI prompt templates page for migration, new tests, and modernization workflows. |
| docs/README.md | Wires AI workflows into the docs home and updates section descriptions (feature parity/roadmap). |
| docfx.json | Includes docs/ai/**.md in DocFX content for publishing. |
| README.md | Refreshes the repo landing page to be evaluation-oriented and test-framework agnostic, with updated doc links. |
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.
Summary
This PR completes the current v4 public-doc cleanup set and keeps the staged AI-doc work in the same change.
What changed
Issue references
Closes #129
Closes #130
Closes #131
Additional included docs work
This PR also includes AI-assisted workflow documentation:
No dedicated issue was found for that AI-doc expansion, so it is included here as related documentation work in the same PR.