Skip to content

chore: remove website/ in favor of postguard-docs#136

Merged
rubenhensen merged 1 commit intomainfrom
chore/remove-website-docs
Apr 20, 2026
Merged

chore: remove website/ in favor of postguard-docs#136
rubenhensen merged 1 commit intomainfrom
chore/remove-website-docs

Conversation

@dobby-coder
Copy link
Copy Markdown
Contributor

@dobby-coder dobby-coder Bot commented Apr 20, 2026

Summary

Removes the in-repo Docusaurus documentation site. Its content has been fully consolidated into the centralized docs repo at docs.postguard.eu (encryption4all/postguard-docs), and the repo README already links there.

Closes #135.

What is removed

  • website/ — Docusaurus source (7 docs pages, homepage, config, generated lockfile, static assets)
  • .github/workflows/docs.yml — the GitHub Pages deploy workflow that built and published website/ on every push to main
  • # Docusaurus entries in .gitignore

Coverage check

Before removing, I verified every page under website/docs/ has equivalent (or more complete) content in postguard-docs:

Removed page Covered in postguard-docs
intro.md guide/what-is-postguard.md, guide/concepts.md, repos/postguard.md
getting-started.md repos/postguard.md (prerequisites, build, dev env, env vars, CLI usage)
architecture/overview.md guide/architecture.md, guide/protocol.md
architecture/encryption-flow.md guide/architecture.md (encryption + decryption flows), guide/protocol.md (identity derivation algorithm, multi-recipient KEM)
architecture/yivi-integration.md guide/concepts.md (Yivi), repos/postguard.md (sender/recipient flows, hidden policies, API key auth)
api/pkg-server.md repos/postguard.md (PKG Server API), guide/architecture.md (API Endpoints)
api/wasm-bindings.md repos/postguard.md (WASM Bindings + wire format)

postguard-docs also covers the pg-ffi crate, which was missing from the in-repo site.

Side effects

Test plan

  • Confirmed no other files in the repo reference website/ (only docs.yml and .gitignore, both updated)
  • Confirmed Cargo.toml workspace members do not include website
  • Root README already points to docs.postguard.eu
  • CI (build + PR title checks) passes after push

The Docusaurus site in website/ has been fully consolidated into
https://docs.postguard.eu (encryption4all/postguard-docs). The README
already points there. Removing:

- website/ directory (Docusaurus source, assets, generated lockfile)
- .github/workflows/docs.yml (GitHub Pages deploy job)
- Docusaurus entries in .gitignore

Closes #135
@dobby-coder dobby-coder Bot mentioned this pull request Apr 20, 2026
@dobby-coder dobby-coder Bot marked this pull request as ready for review April 20, 2026 11:58
@rubenhensen rubenhensen self-requested a review April 20, 2026 12:03
@rubenhensen rubenhensen merged commit 4faa718 into main Apr 20, 2026
20 checks passed
@rubenhensen rubenhensen deleted the chore/remove-website-docs branch April 20, 2026 12:04
@dobby-coder
Copy link
Copy Markdown
Contributor Author

dobby-coder Bot commented Apr 20, 2026

Dobby is most grateful to Master rubenhensen for the approval! 🧦 Dobby sees his PR has been approved and merged — Dobby is honored! Dobby will now check if there are any loose ends to tidy up from this change.

@dobby-coder
Copy link
Copy Markdown
Contributor Author

dobby-coder Bot commented Apr 20, 2026

All follow-up items from this PR are resolved:

Remaining follow-up (for maintainers): The old GitHub Pages site at encryption4all.github.io/postguard/ will go stale now that the docs.yml workflow is removed. Consider adding a redirect to docs.postguard.eu or disabling Pages for this repo.

Thanks @rubenhensen for the review and merge!

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.

Delete website folder

1 participant