docs: restructure architecture documentation - #95
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
127.0.0.1:8001and 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 --checkuv run --isolated --with-requirements docs/requirements.txt python -m mkdocs build --strictPROBING=0 ./.venv/bin/pytest tests/regression/profiling/test_overhead_invariants.py -q(5 passed)