Skip to content

docs: restructure architecture documentation - #95

Merged
reiase merged 1 commit into
masterfrom
feature/docs_restructure
Aug 9, 2026
Merged

docs: restructure architecture documentation#95
reiase merged 1 commit into
masterfrom
feature/docs_restructure

Conversation

@reiase

@reiase reiase commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Consolidate fragmented and legacy architecture pages into a smaller set of bilingual, status-aware design documents.
  • Add dedicated activation/injection and distributed profiler design pages, together with architecture and profiler SVG diagrams.
  • Reorganize the MkDocs navigation and update references across guides, examples, CLI documentation, tests, and contributor guidance.
  • Keep the TorchProbe overhead invariants in the main overhead design document and update the corresponding regression guard.
  • Move the local documentation preview to 127.0.0.1:8001 and invoke MkDocs through the selected Python interpreter.

Why

The architecture documentation had accumulated overlapping pages, duplicated explanations, and stale cross-references. This refactor establishes clearer ownership, reading order, and current-versus-target design status while retaining the relevant technical contracts in consolidated pages.

Impact

This changes documentation structure and developer guidance only; it does not change runtime APIs, SQL table schemas, or collector behavior. Existing links to retired design pages are updated to their new canonical locations.

Validation

  • git diff --check
  • uv run --isolated --with-requirements docs/requirements.txt python -m mkdocs build --strict
  • PROBING=0 ./.venv/bin/pytest tests/regression/profiling/test_overhead_invariants.py -q (5 passed)
  • Verified that retired design-page paths have no remaining tracked references.

@reiase
reiase marked this pull request as ready for review August 9, 2026 02:21
@reiase
reiase merged commit 49c9fdb into master Aug 9, 2026
11 of 12 checks passed
@reiase
reiase deleted the feature/docs_restructure branch August 9, 2026 02:22
@codecov

codecov Bot commented Aug 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
...s/regression/profiling/test_overhead_invariants.py 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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