docs: apply mechanical doc-review fixes#677
Merged
Merged
Conversation
Phase 1 (Must-Fix): resolve wrong relative paths in docs/advanced/ README*.md and related advanced/ files; fix CHANGELOG CONTRIBUTING/ LICENSE links to repo root; correct BUILD_GUIDE, API_REFERENCE, and PERFORMANCE cross-refs; mark non-existent targets (DESIGN_IMPROVEMENTS, PLATFORM_BUILD_GUIDE, LOG_LEVEL_UNIFICATION_PLAN, Korean translations, integration sub-guides) with TODO markers. Fix formatter_macros anchor slug in API_REFERENCE, PATTERNS section-number anchors in FAQ files, and mark FAQ TOC drift in docs/guides/FAQ.md and docs/advanced/ PERFORMANCE.kr.md. Phase 2 (Should-Fix): align CONTRIBUTING.md and PROJECT_STRUCTURE* compiler baseline with README.md (GCC 13+/Clang 17+/MSVC 2022+). Downgrade docs/performance/BASELINE.md status from Released to Draft since all benchmark cells remain TBD; add explicit TODO marker on the primary TBD table.
8 tasks
kcenon
added a commit
that referenced
this pull request
Apr 15, 2026
* docs: apply mechanical doc-review fixes (#677) * docs: fix 74 broken links, 5 anchors, 4 version refs Phase 1 (Must-Fix): resolve wrong relative paths in docs/advanced/ README*.md and related advanced/ files; fix CHANGELOG CONTRIBUTING/ LICENSE links to repo root; correct BUILD_GUIDE, API_REFERENCE, and PERFORMANCE cross-refs; mark non-existent targets (DESIGN_IMPROVEMENTS, PLATFORM_BUILD_GUIDE, LOG_LEVEL_UNIFICATION_PLAN, Korean translations, integration sub-guides) with TODO markers. Fix formatter_macros anchor slug in API_REFERENCE, PATTERNS section-number anchors in FAQ files, and mark FAQ TOC drift in docs/guides/FAQ.md and docs/advanced/ PERFORMANCE.kr.md. Phase 2 (Should-Fix): align CONTRIBUTING.md and PROJECT_STRUCTURE* compiler baseline with README.md (GCC 13+/Clang 17+/MSVC 2022+). Downgrade docs/performance/BASELINE.md status from Released to Draft since all benchmark cells remain TBD; add explicit TODO marker on the primary TBD table. * docs: add post-fix re-validation report * docs(version): update documentation, CHANGELOG, and version for v1.0.0 (#678) * chore(version): bump version to 1.0.0 Update project version from 0.3.1 to 1.0.0 in CMakeLists.txt and vcpkg.json for the stable v1.0 release. * docs(changelog): add v1.0.0 release section Summarize all changes since 0.3.1: queue consolidation, Result<T> migration, API freeze, CMake rename, performance improvements, and comprehensive documentation overhaul. * docs(version): update version refs and coverage claim across all docs Update FetchContent GIT_TAG from v0.3.0 to v1.0.0 in README, guides, and migration docs. Correct code coverage claim from 72% to 49% (verified via Codecov). Update doc frontmatter versions to 1.0.0.
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
1 participant
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
Mechanical doc-review fixes from cross-system audit.
vcpkg.json/CMakeLists.txt<!-- TODO -->markersdocs/advanced/README*.mddepth-drift fixes (~14 links each)Why
157 findings (89 Must-Fix, 61 Should-Fix, 7 Nice-to-Have). Korean
.kr.mdsync and unnamed-SSOT decisions deferred.How
See
DOC_REVIEW_REPORT.mdat repo root.Test Plan
Doc-only changes. No code modifications. No breaking changes.