dennisdoomen / packageguard / 34091574844

81%

main: 81%

push

github

Add a documentation website at packageguard.org (#253)

* Add a documentation website at packageguard.org

Build a Docusaurus site under website/ and publish it to GitHub Pages
whenever website/ changes on main. The layout, PowerShell helper scripts
and component structure follow the Mockly site
(https://github.com/dennisdoomen/mockly/tree/main/website), so both
projects stay easy to maintain together.

The colours come from PackageGuard's own announcement graphics: a
periwinkle blue on near-black navy. Light mode uses the same hue,
deepened for contrast on white.

The dependency versions are pinned through package-lock.json. Webpack
5.110 rejects the options that Docusaurus 3.9 passes to its progress
reporter, so use `npm ci` rather than `npm install` to restore them.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* Move the functional documentation out of the README

Installation, configuration, usage, risk metrics, SBOM output and the
caching and rate-limit notes now live on packageguard.org. The README
keeps the badges, a link list to those pages, and the sections that
describe the repository itself: About, Building, Contributing,
Versioning and Credits.

PreparePackageReadme builds the NuGet readme by picking sections out of
README.md by heading. Update the list of headings it picks, so the NuGet
page shows the new Documentation section instead of headings that no
longer exist.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* Point the NuGet package at packageguard.org

Set PackageProjectUrl to the documentation site, so the "Project website"
link on nuget.org opens the docs rather than the GitHub repository. The
repository stays reachable through RepositoryUrl and the source-link
metadata.

Also mention NPM, PNPM and Yarn in the package description. The tool has
scanned those for a while, but the description still said NuGet only.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* Replace the configuration example on the... (continued)

1975 of 2710 branches covered (72.88%)

Branch coverage included in aggregate %.

6302 of 7480 relevant lines covered (84.25%)

1707.17 hits per line