Skip to content

Reframe Privacy Guard documentation - #26

Merged
johnnygreco merged 8 commits into
mainfrom
johnny/privacy-guard-documentation
Jul 28, 2026
Merged

Reframe Privacy Guard documentation#26
johnnygreco merged 8 commits into
mainfrom
johnny/privacy-guard-documentation

Conversation

@johnnygreco

@johnnygreco johnnygreco commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • replace the previous collection of architecture notes with a task-oriented Privacy Guard documentation set
  • add an overview and end-to-end quickstart, configuration and operations guides, engine guides, architecture references, and limits/failure reference
  • frame Privacy Guard as an experimental proof of concept that reduces exposure but does not guarantee sensitive data cannot leak
  • document the current network-only boundary: harness files, transcripts, and session histories may retain raw sensitive values
  • add accessible, theme-aware request-path, component, pipeline, and lifecycle diagrams
  • publish the measured latency-scaling figure with the limits reference
  • update documentation navigation and project README entry points
  • publish the production documentation automatically after successful pushes to main, while preserving manual republishing
  • make projects/privacy-guard/docs/ the canonical source and generate the top-level publishing mirror during clean builds

Why

The previous pages read as independent information files and mixed usage
guidance with implementation history. This reorganizes the material as direct
software documentation for users, operators, engine authors, and agents.

Validation

  • make check from projects/privacy-guard (243 tests plus formatting, lint, typing, dependency audit, and plot validation)
  • python3 -m unittest tests/test_stage_privacy_guard_docs.py
  • python3 tests/test_render_dev_notes.py
  • scripts/build-docs.sh
  • browser verification in light and dark themes at desktop and mobile widths
  • SVG XML validation and mobile overflow checks
  • multi-agent panel review covering documentation accuracy, logical flow, readability, and CI correctness

@github-actions

github-actions Bot commented Jul 28, 2026

Copy link
Copy Markdown

Documentation preview

The preview has been removed.

@johnnygreco
johnnygreco marked this pull request as ready for review July 28, 2026 22:04
@johnnygreco
johnnygreco merged commit 8463e19 into main Jul 28, 2026
9 checks passed
@johnnygreco
johnnygreco deleted the johnny/privacy-guard-documentation branch July 29, 2026 19:19
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.

1 participant