Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,12 @@ jobs:
with:
dotnet-version: 8.0.4xx

- name: Build public site and HTML documentation
run: python scripts/build-public-site.py --output artifacts/public-site

- name: Validate public site
shell: pwsh
run: .\scripts\validate-public-site.ps1
run: .\scripts\validate-public-site.ps1 -SiteRoot artifacts/public-site

- name: Restore Publisher
run: dotnet restore src/ARSVIN/ARSVIN.csproj
Expand Down
14 changes: 6 additions & 8 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
paths:
- 'site/**'
- 'docs/**'
- 'scripts/build-public-site.py'
- 'scripts/validate-public-site.ps1'
- '.github/workflows/pages.yml'
workflow_dispatch:
Expand All @@ -29,23 +30,20 @@ jobs:
- name: Checkout
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7

- name: Build public site and HTML documentation
run: python3 scripts/build-public-site.py --output artifacts/public-site

- name: Validate public site
shell: pwsh
run: ./scripts/validate-public-site.ps1

- name: Prepare site
run: |
mkdir -p site/docs
cp -R docs/* site/docs/
touch site/.nojekyll
run: ./scripts/validate-public-site.ps1 -SiteRoot artifacts/public-site

- name: Configure Pages
uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5
with:
path: site
path: artifacts/public-site

- name: Deploy
id: deployment
Expand Down
14 changes: 13 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,23 @@ All notable ARSVIN changes are documented here using a lightweight Keep a Change

## Unreleased

### Added

- Added a repository-owned, dependency-free public-site builder that converts every `docs/*.md` guide into a dedicated HTML page.
- Added compact documentation navigation, topic filtering, breadcrumbs, source links, responsive styling, and a generated search index.
- Added unique canonical URLs, descriptions, Open Graph metadata, Twitter Card metadata, and `TechArticle` JSON-LD for engineering documentation pages.
- Added a generated multi-page sitemap containing the product homepage and every published documentation page.
- Added recursive validation for all HTML metadata, structured data, canonical uniqueness, local references, search-index targets, sitemap coverage, web-manifest icons, and robots metadata.

### Changed

- GitHub Pages and Windows CI now build and validate the same staged public-site artifact instead of copying raw Markdown into the deployment directory.
- The product landing page now links directly to Quick Start, SV Profile Support, COMTRADE Replay, Subscriber Verification, Safety Boundaries, and the complete documentation index.

### Planned

- Move the engine source directory physically under `src/ARSVIN.Engine` after the shared-assembly transition has proven stable.
- Expand protocol regression tests and raise the whole-engine coverage baseline progressively.
- Publish search-indexable HTML engineering documentation with a multi-page sitemap.
- Add Windows Authenticode signing when a trusted certificate becomes available.

## 0.3.1 — 2026-07-12
Expand Down
Loading
Loading