docs: Fix installation commands and resolve broken documentation links #6
Conversation
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
Fixed multiple documentation issues: 1. Added --prerelease flag to all installation commands - README.md - docs/getting-started/installation.md - docs/getting-started/quick-start.md - docs/index.md - Updated PowerShell command to use -Prerelease - Updated version references to 1.0.0-beta 2. Removed broken troubleshooting link from README.md - Link pointed to non-existent docs/advanced/troubleshooting.md 3. Created stub documentation files with TODO placeholders - docs/usage/opt-out.md - Opt-out mechanisms - docs/advanced/keyed-services.md - Keyed services strategy - docs/advanced/performance.md - Performance characteristics - docs/advanced/troubleshooting.md - Common issues and solutions - docs/api-reference/generated-code.md - Generated code structure All stubs include "Coming Soon" notices and planned content outlines 4. Updated test commands to use MTP format - docs/contributing.md - Multiple locations - CLAUDE.md - Build commands section - Changed from 'dotnet test' to 'dotnet run --framework net8.0' - Added notes about MTP and multi-framework targeting This resolves all broken navigation links in mkdocs.yml and ensures users can successfully install the prerelease package. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Updated package reference to use wildcard version (1.0.0-beta.*) and added note explaining that GHA appends build numbers to the version prefix. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Changed description from 'full open generic support' to 'support for closed generic registrations' to accurately reflect current implementation. The generator currently intercepts closed generic registrations like: services.AddScoped(typeof(IRepository<>), typeof(SqlRepository<>)) Open generic support (intercepting AddScoped<IRepository<T>, SqlRepo<T>>) is planned for a future phase. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Added 5 new tags to improve package searchability: - csharp: Common search term for C# specific packages - decorators: Plural form of decorator pattern - code-generation: Alternative term for source generation - cross-cutting: Describes cross-cutting concerns use case - performance: Highlights zero runtime overhead benefit Total tags increased from 10 to 15 for better NuGet search coverage. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
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
Comprehensive documentation fixes addressing installation commands, broken links, and test command updates.
Changes
1. Fixed Installation Commands (Prerelease Flag)
Updated all installation commands to include
--prereleaseflag since the package is currently1.0.0-beta:dotnet add packagecommand.csprojexamples2. Removed Broken Troubleshooting Link
3. Created Stub Documentation Files
Created 5 new documentation files with "Coming Soon" placeholders and planned content outlines:
All stubs include:
4. Updated Test Commands for MTP
Updated test commands throughout documentation to use Microsoft Testing Platform (MTP) format:
Changed from:
dotnet testTo:
Added notes explaining that the test project targets multiple frameworks (net8.0, net9.0, net10.0) and requires
--frameworkspecification.Impact
Testing
--prereleaseflag--framework net8.0🤖 Generated with Claude Code