Skip to content

Sanitize public documentation surface - #82

Merged
valiantone merged 1 commit into
mainfrom
codex/docs-sanitize-public-surface
Aug 18, 2026
Merged

Sanitize public documentation surface#82
valiantone merged 1 commit into
mainfrom
codex/docs-sanitize-public-surface

Conversation

@valiantone

Copy link
Copy Markdown
Contributor

Summary

  • Remove internal YC/session-trace, OKF planning, Hermes campaign, documentation-service, and root planning artifacts from the public tree.
  • Replace them with a concise public architecture overview and current-capability documentation.
  • Remove proprietary stack references from runtime messages/comments/tests and delete generated manifests containing machine-specific paths.

Why

The docs site was ready to publish but exposed internal processes, unrelated implementation planning, and proprietary architecture boundaries. This keeps the public docs focused on shipped HotMem behavior.

Validation

  • uv run --locked --extra docs mkdocs build --strict
  • uv run ruff check src/ tests/
  • uv run pytest -q — 389 passed, 6 skipped
  • Residual scan of the repository and generated site for removed sensitive terms and paths

Note

This sanitizes the current tree. Previously published Git history is unchanged and would require a separate reviewed history rewrite if needed.

@valiantone
valiantone requested a review from alphakenz August 17, 2026 14:07
@valiantone
valiantone marked this pull request as ready for review August 17, 2026 14:07
@valiantone
valiantone force-pushed the codex/docs-sanitize-public-surface branch from 24b597c to 2d32640 Compare August 17, 2026 14:10
@valiantone valiantone self-assigned this Aug 17, 2026
@valiantone valiantone added this to the Phase 3: DX Polish milestone Aug 17, 2026
@valiantone valiantone added documentation Improvements or additions to documentation area:design Architecture, RFC, ADR, roadmap labels Aug 17, 2026
@valiantone
valiantone merged commit f41296a into main Aug 18, 2026
10 checks passed
@valiantone
valiantone deleted the codex/docs-sanitize-public-surface branch August 18, 2026 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:design Architecture, RFC, ADR, roadmap documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant