Skip to content

Add documentation project to Visual Studio solution #37

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.

Sign up for GitHub

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

Merged
Reefact merged 4 commits into from
Jul 6, 2026
+61 −1
Merged

Add documentation project to Visual Studio solution #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5e7051a
Add documentation-only project to browse docs in Visual Studio
claude Jul 6, 2026
3c101c7
Include documentation image assets in the docs project
claude Jul 6, 2026
b587c1d
Surface every file under doc/ in the docs project
claude Jul 6, 2026
a249906
Link the root README into the documentation project
claude Jul 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion FirstClassErrors.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
ProjectSection(SolutionItems) = preProject
.gitignore = .gitignore
LICENSE = LICENSE
README.md = README.md
EndProjectSection
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FirstClassErrors.Documentation", "doc\FirstClassErrors.Documentation.csproj", "{0FD6C7A3-6832-491A-96C1-F33F62C56EEB}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "doc", "doc", "{F75115F0-25B9-49BC-AE36-A39F2175727A}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -73,6 +76,8 @@ Global
{2BE1F2DB-4A9E-4616-89BA-9A597B721217}.Debug|Any CPU.Build.0 = Debug|Any CPU
{2BE1F2DB-4A9E-4616-89BA-9A597B721217}.Release|Any CPU.ActiveCfg = Release|Any CPU
{2BE1F2DB-4A9E-4616-89BA-9A597B721217}.Release|Any CPU.Build.0 = Release|Any CPU
{0FD6C7A3-6832-491A-96C1-F33F62C56EEB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{0FD6C7A3-6832-491A-96C1-F33F62C56EEB}.Release|Any CPU.ActiveCfg = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand All @@ -87,6 +92,7 @@ Global
{D8B4E1F6-2C7A-4F93-8B05-1E6D9A3C4B72} = {B7C3D08D-EFC5-4F5D-8DE4-5B7938354DBB}
{47052422-15BC-482A-8FC0-65F9AAAB0291} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8}
{2BE1F2DB-4A9E-4616-89BA-9A597B721217} = {B7C3D08D-EFC5-4F5D-8DE4-5B7938354DBB}
{0FD6C7A3-6832-491A-96C1-F33F62C56EEB} = {F75115F0-25B9-49BC-AE36-A39F2175727A}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {4988972E-3E0D-4F48-8656-0E67ECE994BF}
Expand Down
54 changes: 54 additions & 0 deletions doc/FirstClassErrors.Documentation.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<Project Sdk="Microsoft.NET.Sdk">

<!--
Documentation-only project.

This project compiles nothing. Its sole purpose is to surface everything
under doc/ in the Visual Studio Solution Explorer, so the documentation is
easy to find, read and edit right next to the code: the Markdown pages
(English *.en.md and French *.fr.md, including the analyzer pages under
analyzers/), the images, and any other asset that may be added later.

The <None> glob below picks up new files automatically: no need to touch
this project or the solution when documentation is added or renamed. The
repository's root README.md is also linked in, so it is browsable here too.

Nothing is built: no *.cs is compiled (EnableDefaultItems=false) and no
assembly is produced (IncludeBuildOutput=false). The project is also
excluded from the solution build configurations, so both
`dotnet build FirstClassErrors.sln` and "Build Solution" in Visual Studio
simply skip it. It therefore adds no build cost and no new dependency.

TargetFramework is set only because the SDK requires one; it reuses the
netstandard2.0 targeting pack already restored by the main library.
-->

<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<EnableDefaultItems>false</EnableDefaultItems>
<IncludeBuildOutput>false</IncludeBuildOutput>
<GenerateDocumentationFile>false</GenerateDocumentationFile>
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
<IsPackable>false</IsPackable>
</PropertyGroup>

<ItemGroup>
<!--
Show every file under doc/ (Markdown pages, images and any other asset),
so nothing is ever missing from the Solution Explorer view. Only the
build artifacts (obj/, bin/) and this project file itself are excluded.
-->
<None Include="**\*" Exclude="obj\**;bin\**;*.csproj" />
</ItemGroup>

<ItemGroup>
<!--
The repository's main README lives at the solution root, outside doc/, so
the glob above cannot reach it. Reference it as a link so it is browsable
from this project too. Link metadata is required for files located outside
the project directory.
-->
<None Include="..\README.md" Link="README.md" />
</ItemGroup>

</Project>
Loading