[MSBUILD SDK] Add rule docs for new SDK #3298
Merged
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
jviau
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for the new SDK error rules introduced in Azure.Functions.Sdk. The documentation follows a structured format to help developers understand and resolve SDK-related errors and warnings.
Changes:
- Added index page for SDK rules documentation
- Created documentation template for SDK rules
- Added documentation for 8 SDK rules (AZFW0100-AZFW0107) covering various validation scenarios
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/sdk-rules/index.md | Added index page title for SDK rules documentation |
| docs/sdk-rules/RULE_TEMPLATE.md | Added template for documenting SDK rules |
| docs/sdk-rules/AZFW0100.md | Documents error when func CLI cannot be launched |
| docs/sdk-rules/AZFW0101.md | Documents error for conflicting extension package versions |
| docs/sdk-rules/AZFW0102.md | Documents warning for duplicate extension packages |
| docs/sdk-rules/AZFW0103.md | Documents error for invalid extension package versions |
| docs/sdk-rules/AZFW0104.md | Documents warning for end-of-life Functions versions |
| docs/sdk-rules/AZFW0105.md | Documents error for using incompatible SDK packages |
| docs/sdk-rules/AZFW0106.md | Documents error for unknown Functions versions |
| docs/sdk-rules/AZFW0107.md | Documents warning for unsupported target frameworks |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jviau
force-pushed
the
jviau/msbuild-sdk/docs
branch
from
acbe967 to
ff5c8c1
Compare
RohitRanjanMS
approved these changes
Jan 23, 2026
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.
Issue describing the changes in this PR
resolves #issue_for_this_pr
Pull request checklist
release_notes.mdAdditional information
Add docs for the new SDK errors in
Azure.Functions.Sdk.