Documentation - KevinDHeath/NuGetPackages GitHub Wiki

The KevinDHeath.github.io repository is used to deploy the documentation to GitHub Pages.

These tasks need to be performed before publishing a new release:

Preparing Help documentation

⚠️ Sandcastle Help File Builder (SHFB) is used to generate the packages help, see Installation Instructions for details on how to install it.
The Resolve Third-Party Reference Links custom component must also be built and deployed one time.

In the NuGetPackages repository make sure all necessary docs/*.shfbproj projects have been built.
In the KevinDHeath.github.io repository:
1. Run the ./tools/shfbImport.ps1 script for nuget and\or shfbto import the regenerated output.
2. Run the ./tool/shfbOverlay.ps1 script to overlay the customized files for all SHFB projects.
3. The Testing section has information on testing the modifications before deploying.

CSS Customizations

tools/css

bulma.css @import "../../css/bulma/v100/bulma.min.css"; Imports the minimized version
font-awesome.min.css @import "../../css/font-awesome/v611/css/font-awesome.min.css";
presentationStyle.css @import "../../css/shfb.css"; Imports the SHFB presentationStyle.css and defines the modifications

HTML Customizations

tools/nuget/html

R_Project_NuGetPackages.htm
1. Add the following paragraphs before and after the Namespaces table:

          <p>This site contains technical information about the .NET Helper packages available on
            <a href="https://www.nuget.org/packages?q=owner:KevinDHeath id:helper id:common&sortby=created-desc" target="_blank">NuGet</a>.</p>

            <p><strong>Note:</strong> The documentation for the other packages can be found at
              <a href="../../shfb/index.html">WPF Packages.</a></p>

tools/shfb/html

9488fab8-02de-4046-a582-c44f4c2a945f.htm (Introduction.aml)
1. Remove: <meta name="Description" content="info." />
2. Replace: <h1>Components</h1> with <h1>Introduction</h1>
3. Add <td nowrap> to 1st row left column of the Components table.
4. Add the following paragraphs before and after the Components table:

            <p>This site contains technical information about the Windows Presentation Foundation (WPF) packages available on
              <a href="https://www.nuget.org/packages?q=owner:KevinDHeath id:wpf&sortby=created-desc" target="_blank">NuGet</a>.</p>

            <p><strong>Note:</strong> The documentation for the other packages can be found at
              <a href="../../nuget/index.html">.NET Helper Packages.</a></p>

e6e60a0c-f708-479e-bc65-bcdc99253c7b.htm (Themes/_Overview.aml)
1. In Dictionary Dependencies table sub-headings [Common.Wpf.Resources] and [Common.Wpf.Controls] add <td class="thin is-info">
2. For all others in Dictionary Dependencies add <td class="thin">

Preparing Code coverage reports

Submit the 🚥 Run Tests action in the NuGetPackages repository and download the NuGetPackages-UnitTests artifact.
Copy the TestResults folder from the zip file to the NuGetPackages repository tests/Unit folder.
Run the ./tools/ccrgImport.ps1.ps1 script in the KevinDHeath.github.io repository to import the regenerated results.
Modify the index.html files to remove the unwanted elements (see HTML Customizations).

HTML Customizations

code/[project]/html/index.html

Remove the Sponsor and Star buttons <h1>Summary - XXX.Tests</h1>
Remove the Method coverage (only available for sponsors)

<div class="card">
<div class="card-header">Method coverage</div>
<div class="card-body">
<div class="center">
<p>Feature is only available for sponsors</p>
<a class="pro-button" href="https://reportgenerator.io/pro" target="_blank">Upgrade to PRO version</a>
</div>
</div>
</div>

Comment out the invalid CDATA block inside the Style section

        /*<![CDATA[*/
        /*]]>*/

Documentation - KevinDHeath/NuGetPackages GitHub Wiki

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️