Skip to content

Documentation Overhaul + Phase 2 E2E Validation Complete - #1

Merged
Mattral merged 1 commit into
mainfrom
chore/release-docs
Sep 12, 2026
Merged

Mattral merged 1 commit into
mainfrom
chore/release-docs

Conversation

@Mattral

@Mattral Mattral commented Sep 12, 2026

Copy link
Copy Markdown
Owner

Documentation Overhaul + Phase 2 E2E Validation Complete

📚 Documentation

  • Fact‑checked the 5 already‑rewritten docs (SYSTEM_DESIGN, SETUP_AND_OPERATIONS, SECURITY, CONTRIBUTING, PHILOSOPHY) against actual code — all accurate, no changes needed.
  • Completely rewrote README.md:
    • Removed infra claims (Triton/Qdrant/Postgres/Terraform/Airflow/Dask/Flagger/W&B).
    • Removed CI/coverage badges and fabricated latency/throughput numbers.
    • Added honest description of the real 2‑tier architecture (guardrail‑rs Rust proxy + FastAPI/React/Mongo control plane).
    • Embedded 3 real UI screenshots.
    • Added explicit “Honest status” section of what is/isn’t built.
  • Fixed filename/content mismatch in the 3 screenshots and correctly embedded them.
  • Rewrote frontend/README.md to reflect the real yarn workflow and pages (was untouched CRA boilerplate).
  • Completely rewrote docs/USER_GUIDE_AND_UI.md:

✅ Phase 2 E2E Validation

  • First full browser‑driven pass with testing_agent_v3 across all 5 pages + backend API.
  • Results: backend 50/50, frontend 100%, zero bugs found.
  • Verified flows:
    • Allow/block/redact
    • Redaction proof
    • Policy add/validate/save/hot‑reload/remove round‑trip
    • Audit log search/filter/pagination/detail drawer
    • Upstream switching (mock ↔ Gemini) with correct toast notifications

This PR consolidates the honest documentation rewrite and the successful Phase 2 validation run, setting the stage for Phase 3 feature development.

… screenshots

- Remove fictional infra claims (Triton/Qdrant/Postgres/Terraform/Airflow/
  Dask/Flagger/W&B) and fabricated benchmark numbers from README and docs
- Rewrite README.md with real architecture (guardrail-rs Rust proxy +
  FastAPI/React/Mongo control plane), embed 3 real UI screenshots, and add
  an explicit "Honest status" section
- Rewrite docs/USER_GUIDE_AND_UI.md to document the actual 5-page UI
  (Overview, Test a Prompt, Policy Editor, Audit Log, Settings)
- Fix frontend/README.md to reflect real yarn workflow
- Fix screenshot filename/content mismatch in docs/screenshots/
- Complete first full testing_agent_v3 E2E pass: backend 50/50, frontend
  100%, zero bugs found across all pages and flows

Co-authored-by: DavidMacha <148528760+DavidMacha@users.noreply.github.com>
@Mattral Mattral changed the title ## Documentation Overhaul + Phase 2 E2E Validation Complete Documentation Overhaul + Phase 2 E2E Validation Complete Sep 12, 2026
@Mattral
Mattral merged commit 20eb2da into main Sep 12, 2026
1 of 10 checks passed
@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

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.

2 participants