Skip to content

docs: split 3 oversized documents into focused sub-documents#666

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-665-split-docs
Apr 9, 2026
Merged

docs: split 3 oversized documents into focused sub-documents#666
kcenon merged 1 commit into
mainfrom
docs/issue-665-split-docs

Conversation

@kcenon

@kcenon kcenon commented Apr 9, 2026

Copy link
Copy Markdown
Owner

Closes #665

Summary

Split 3 oversized documentation files (48-58KB each) into 6 focused sub-documents.

Original Size Split Into
DIAGNOSTICS_METRICS_GUIDE.md 48KB DIAGNOSTICS_GUIDE.md, METRICS_GUIDE.md
ARCHITECTURE_DIAGRAM.md 58KB ARCHITECTURE_OVERVIEW.md, ARCHITECTURE_DETAILS.md
advanced/PERFORMANCE.md 55KB PERFORMANCE_BENCHMARKS.md, PERFORMANCE_TUNING.md

Test Plan

  • All split document links resolve correctly

- DIAGNOSTICS_METRICS_GUIDE.md (48KB) -> diagnostics + metrics
- ARCHITECTURE_DIAGRAM.md (58KB) -> overview + details
- advanced/PERFORMANCE.md (55KB) -> benchmarks + tuning
Original files replaced with index pages.

Closes #665
@github-actions

github-actions Bot commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

📊 Performance Benchmark Results

Performance Benchmark Report

No benchmark data available.

ℹ️ No baseline reference available

This is the first benchmark run or baseline file is missing.

@kcenon kcenon merged commit 303ee52 into main Apr 9, 2026
27 checks passed
@kcenon kcenon deleted the docs/issue-665-split-docs branch April 9, 2026 00:52
kcenon added a commit that referenced this pull request Apr 13, 2026
- DIAGNOSTICS_METRICS_GUIDE.md (48KB) -> diagnostics + metrics
- ARCHITECTURE_DIAGRAM.md (58KB) -> overview + details
- advanced/PERFORMANCE.md (55KB) -> benchmarks + tuning
Original files replaced with index pages.

Closes #665
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.

[Enhancement] Split oversized documentation and standardize README

1 participant