-
Notifications
You must be signed in to change notification settings - Fork 497
Add solution file and project to make it easier to load docs in Visual Studio #3496
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds Visual Studio solution and project files to enable easier documentation editing in Visual Studio. The changes introduce a no-targets MSBuild project that allows the documentation files to be browsed and edited through Visual Studio's Solution Explorer.
Key Changes:
- Added a
global.jsonfile specifying the Microsoft.Build.NoTargets SDK version - Created a
docs.csprojproject file using the NoTargets SDK targeting .NET Framework 4.7.2 - Created a
docs.slnsolution file that includes the docs project and common repository files
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| global.json | Specifies the Microsoft.Build.NoTargets SDK version for the project |
| docs/docs.csproj | Defines a no-targets project for organizing documentation files in Visual Studio |
| docs.sln | Solution file that references the docs project and includes relevant repository files in Solution Items |
|
Learn Build status updates of commit 29e6f28: ✅ Validation status: passed
For more details, please refer to the build report. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
Co-authored-by: Copilot <[email protected]>
|
Learn Build status updates of commit 2f5eaa3: ✅ Validation status: passed
For more details, please refer to the build report. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting. I've never thought about building the docs repo locally. Could you share an example of what this will make easier?
|
Unfortunately, this does not make it so you can "build" the docs locally. You can build in VS but it doesn't really do anything. The main point of this is to load everything up in Visual Studio so you can browse the files, open them, search, etc. I spent a few minutes seeing if there was a way to run the OpenPublishing stuff locally but couldn't find any info so I didn't pursue it further. |
This makes it a lot easier for me to edit docs and is entirely optional for people interacting with this repo