Skip to content

Add missing README information to centralized repo docs#12

Merged
dobby-coder[bot] merged 1 commit intocentralize-docsfrom
add-missing-readme-info-v2
Apr 15, 2026
Merged

Add missing README information to centralized repo docs#12
dobby-coder[bot] merged 1 commit intocentralize-docsfrom
add-missing-readme-info-v2

Conversation

@dobby-coder
Copy link
Copy Markdown
Contributor

@dobby-coder dobby-coder bot commented Apr 14, 2026

Summary

Addresses feedback from @rubenhensen on #8 — information from repo READMEs was missing in the centralized docs pages.

Audited all 16 non-archived repo READMEs against their corresponding docs/repos/*.md pages. Five repos had missing information:

  • pdf-signature (specifically called out): Added frontend development setup, backend configuration table with all config options, build/run commands
  • cryptify: Added backend configuration table with all config file options (server_url, address, data_dir, SMTP settings, allowed_origins, pkg_url), commands for running the built binary
  • postguard: Added unaudited warning, expanded 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 table, CLI usage examples (encrypt/decrypt), reference to Docusaurus site, funding section (NGI0/NLnet/NWO)
  • postguard-fallback: Added dependency versions table (Rust 1.57, NGINX 1.21, PostgreSQL 12, Mailhog 1.0), links to IRMA documentation and irmaseal design document
  • postguard-website: Added Docker stopping commands, docker-compose build command

The remaining 11 repos (ibe, ibs, irmaseal-mail-utils, pg-components, pg-curve, pg-example, postguard-js, postguard-dotnet, postguard-tb-addon, postguard-outlook-addon, postguard-examples) were verified to already contain all information from their READMEs.

Test plan

  • Review each changed file against the original repo README to confirm all info is captured
  • Build the VitePress site and verify pages render correctly
  • Check that no banned words from CLAUDE.md style guide are used

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>
@dobby-coder dobby-coder bot merged commit ed40dd4 into centralize-docs Apr 15, 2026
1 check passed
@dobby-coder dobby-coder bot mentioned this pull request Apr 15, 2026
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants