Add centralized repository documentation#9
Merged
rubenhensen merged 12 commits intomainfrom Apr 15, 2026
Merged
Conversation
Add a new "Repositories" section to the docs site with: - Overview page showing all repos, their roles, and a dependency graph - Individual documentation pages for all 16 non-archived repos - Each page includes: description, development quickstart, release process, CI/CD info - Updated VitePress sidebar and navigation to include the new section - Standardized README for the docs repo itself Closes #8 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The postguard repo contains a Docusaurus docs website in website/ that was not accounted for during the initial documentation centralization. This updates the repos/postguard.md page to incorporate the content from that website, including: - Mention of the existing Docusaurus site and its GitHub Pages URL - Cryptographic primitives table and pg-core feature flags - Full development setup: prerequisites, building each crate, WASM build, docker-compose, environment variables - PKG server setup: key generation, running, Docker deployment - CLI usage examples for encrypt and decrypt - PKG Server API endpoint reference - WASM bindings overview with cross-references to the SDK docs Relates to #8 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Audited all 16 repo READMEs against the centralized docs pages and added missing information. Main additions: - pdf-signature: configuration parameters table, backend build/run commands, frontend setup, Electron packaging, API endpoints - cryptify: configuration parameters table, API endpoints reference - postguard: cryptographic primitives, prerequisites with versions, build commands per crate, Docker dev environment, environment variables, CLI usage examples, full PKG server API reference, WASM bindings API, wire format spec, Yivi integration details - postguard-website: stopping services, Docker build commands, USB debugging prerequisites, service list - postguard-fallback: IRMA attribute details, technical references, software versions, Trunk/Yew framework docs - postguard-js: email envelope property descriptions, standalone helpers import note, inline code comments - postguard-examples: pg-dotnet use case details, code example, project structure diagram - postguard-tb-addon: build output clarification Closes #8 (partial) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Audited all 16 repo READMEs against their centralized docs pages and added missing content: - pdf-signature: frontend setup, backend configuration table, build/run commands - cryptify: backend configuration table with all config options, build/run commands including running the built binary - postguard: unaudited warning, prerequisites (Rust 1.90+, Docker, wasm-pack), WASM build instructions, Docker Compose dev environment, PKG server setup with key generation and CLI flags, environment variables, CLI usage examples (encrypt/decrypt), Docusaurus site reference, funding section - postguard-fallback: dependency version table (Rust 1.57, NGINX 1.21, PostgreSQL 12, Mailhog 1.0), IRMA/irmaseal documentation links - postguard-website: Docker stopping commands, docker-compose build Resolves feedback on #8. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ntralize-docs # Conflicts: # docs/repos/postguard.md
… centralize-docs # Conflicts: # docs/repos/pdf-signature.md # docs/repos/postguard-fallback.md # docs/repos/postguard-website.md # docs/repos/postguard.md
Adds the PostGuard session flow diagram and numbered steps to the architecture page, providing a high-level overview before the detailed encryption and decryption flow breakdowns. Requested in encryption4all/postguard#130 review feedback. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2 tasks
Add a new Protocol Specification page covering the formal cryptographic protocol (Sign-then-Encrypt composition, IBKEM, mIBKEM, IBS), identity derivation algorithm, wire format details, JSON header format, email MIME format, and academic references. Includes diagrams from the internal hand-off document.
Move web-app integration content into pg-sveltekit and pg-dotnet as separate pages. Move email-addon integration content into postguard-tb-addon and postguard-outlook-addon. Remove the Integrations section entirely. Restructure sidebar: move applications into Core, remove postguard-fallback (no longer used), remove pg-example/pdf-signature/ postguard-docs pages, replace Examples & Docs with postguard-examples group containing pg-sveltekit and pg-dotnet.
Split SDK Reference into Overview (with feature comparison table), Getting Started (both SDKs), JavaScript SDK (5 pages), and .NET SDK (2 pages). Merge guide/getting-started into sdk/getting-started with bundler config, decrypt example, and both SDK quick starts.
rubenhensen
approved these changes
Apr 15, 2026
Contributor
Author
|
Dobby has seen the approval on this pull request! 🧦 Dobby is most pleased that Master rubenhensen has approved this work. Dobby will now review the current state and see what needs to be done to help move things along! |
dobby-coder bot
added a commit
that referenced
this pull request
Apr 15, 2026
Adds the postguard-flow.png image to the session flow section of the postguard repository documentation page. This image was present in the original postguard README but was missing from the centralized docs page. The image already exists in docs/public/ and is used in the architecture guide; this adds it to the repo-specific page as well. Addresses review feedback on PR #9.
3 tasks
Contributor
Author
|
Thanks for the review feedback about the missing images, @rubenhensen. I've added the session flow diagram ( |
Contributor
|
/dobby we merged this pull request, but a lot of changes were made, make sure all the readmes you changed for issue 8 are still correct |
Contributor
Author
|
Dobby has heard the call! 🧝 Dobby will inspect every README that Dobby changed for issue #8 and make sure they are still correct after the merge. Dobby is very thorough and will not rest until every word is verified, sir! |
Contributor
Author
README verification after PR #9 mergeI checked all 16 README PRs that were created for issue #8. Here's what I found and fixed: Fixed: 5 READMEs with broken docs linksDuring the review of PR #9, several docs pages were removed or restructured. Five README PRs linked to pages that no longer exist. I've updated them to link to
Verified correct: 11 README PRsThese link to pages that exist and the content is accurate:
Note: postguard-tb-addon logoThe postguard-tb-addon README was already merged (PR #66) but is missing the PostGuard logo at the top. PR #71 adds it and is still open for review. Docs site verifiedBuilt the docs site from the merged main branch — all 14 repo pages compile and render correctly. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Centralizes all PostGuard documentation into this docs site. Adds a new "Repositories" section with documentation pages for all 16 non-archived repos in the encryption4all organization.
This PR consolidates the work from PRs #10, #11, and #12 (all now merged into this branch).
What's included
The sidebar organizes repos into: Cryptographic Libraries, Core, SDKs, Applications, and Examples & Docs.
Companion README PRs
Standardized README PRs have been created on every non-archived repo to point to docs.postguard.eu.
Closes #8
Test plan