From 5e8057bb1ffcc2568dc33f96740129fb16595b6f Mon Sep 17 00:00:00 2001 From: nopeitsnothing Date: Sat, 25 Apr 2026 17:35:53 -0400 Subject: [PATCH] Fix copy information in website footer And also move the develop workflow information to docs/code to cleanup the guide documents, preventing accidental addition to the PDF. Signed-off-by: nopeitsnothing --- .github/workflows/build-sign-release.yml | 2 +- docs/guide/dev-workflow.md | 50 ------------------------ mkdocs.yml | 7 ++-- 3 files changed, 5 insertions(+), 54 deletions(-) delete mode 100644 docs/guide/dev-workflow.md diff --git a/.github/workflows/build-sign-release.yml b/.github/workflows/build-sign-release.yml index ccf69bc..982d985 100644 --- a/.github/workflows/build-sign-release.yml +++ b/.github/workflows/build-sign-release.yml @@ -97,7 +97,7 @@ jobs: - name: 📤 Upload export directory as artifact uses: actions/upload-artifact@v4 with: - name: export + name: upload pdf artifact path: | export/* if-no-files-found: error diff --git a/docs/guide/dev-workflow.md b/docs/guide/dev-workflow.md deleted file mode 100644 index c55a068..0000000 --- a/docs/guide/dev-workflow.md +++ /dev/null @@ -1,50 +0,0 @@ -# Development - -??? Note "How the pipeline works" - - **Automatic PDF Generation:** - Builds both light and dark mode PDFs from MkDocs source - **SHA256 Hash Generation:** - Creates hash files for integrity verification - **GPG Signature Signing:** - Signs all PDFs and hash files with repository GPG key - **VirusTotal Scanning:** - Automatically scans PDFs and updates release notes - **Release Automation:** - Packages everything into GitHub releases - -## Architecture - -### Build PDF Workflow (`build-sign-release.yml`) - -!!! Note "Steps" - - - Checkout repository - - Set up Python and MkDocs Material - - Install Chromium browser - - Generate both light and dark mode PDFs with `scripts\build_guide_pdf.py` - - Create SHA256 and blake2 hash files in `export/` - - Sign all files with GPG in `export/` - - Upload artifacts to GitHub Actions **manually** - -### SHA256 Hash Verification - -!!! Note "**How it works**" - - - Each PDF gets a unique SHA256 hash calculated at build time - - Hash stored in `.sha256` files alongside the PDFs - - Combined `sha256sum.txt` for batch verification - -### GPG Signature Verification - -**Purpose:** Verify authenticity and prevent tampering - -!!! Note "How it works" - - - Detached signatures created for each PDF and hash file - - Public keys available in `/pgp/` directory - -**Verification command:** -```bash -gpg --import pgp/anonymousplanet-master.asc -gpg --verify export/thgtoa.pdf.sig export/thgtoa.pdf -``` - ---- - -*This workflow is designed for security-conscious users who need to verify the authenticity and integrity of downloaded documents.* diff --git a/mkdocs.yml b/mkdocs.yml index c36f1e1..9db07d0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -130,8 +130,9 @@ nav: - Verify: verify/index.md - Guide: - guide/index.md - - Workflow Documentation: guide/dev-workflow.md - - Code: code/index.md + - Code: + - code/index.md + - Develop: code/develop.md - Contribute: contribute/index.md - Constitution: constitution/index.md - Mirrors: mirrors/index.md @@ -139,4 +140,4 @@ nav: - Releases: changelog/index.md copyright: | - © 2023-2026 Anonymous Planet + The Hitchhiker's Guide ©2023-2026 by Anonymous Planet is licensed under CC BY-NC 4.0