docs: fix broken links and add missing documentation#283
Merged
Conversation
Create QUICK_START.md and QUICK_START_KO.md with: - Prerequisites and installation steps - First thread pool example with CMake integration - Key concepts: thread pool, workers, jobs - Common patterns: parallel processing, error handling - Links to related documentation Closes partially #282
Create TROUBLESHOOTING.md and TROUBLESHOOTING_KO.md covering: - Build issues: C++20, vcpkg, compiler, linker errors - Runtime issues: thread pool startup, deadlock, memory leaks - Performance issues: throughput, CPU usage, lock contention - Platform-specific issues: macOS, Windows, Linux Closes partially #282
Create CPP20_CONCEPTS.md and CPP20_CONCEPTS_KO.md documenting: - Available concepts: Callable, VoidCallable, JobType, PoolJob, etc. - Usage examples with code samples - Type traits: is_duration, is_future_like, callable_return_type - Compiler requirements for C++20 concepts - C++17 fallback behavior - Integration with common_system This documents recent C++20 concepts integration (commits dbc3363, e182091, 9122fa3) which previously lacked documentation. Closes partially #282
Fix 5 broken links in README.md: - docs/guides/USER_GUIDE.md -> docs/advanced/USER_GUIDE.md - docs/guides/API_REFERENCE.md -> docs/advanced/02-API_REFERENCE.md - docs/advanced/ARCHITECTURE.md -> docs/advanced/01-ARCHITECTURE.md - docs/guides/MIGRATION_GUIDE.md -> docs/advanced/MIGRATION.md - Add link to new C++20 Concepts documentation Update README_KO.md documentation section: - Add structured documentation sections matching English README - Update all documentation links to correct paths - Add links to new QUICK_START_KO and TROUBLESHOOTING_KO guides Closes #282
Contributor
📊 Performance Benchmark ResultsPerformance Benchmark ReportNo benchmark data available. ℹ️ No baseline reference availableThis is the first benchmark run or baseline file is missing. |
5 tasks
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
* docs(guides): add Quick Start guide for 5-minute setup Create QUICK_START.md and QUICK_START_KO.md with: - Prerequisites and installation steps - First thread pool example with CMake integration - Key concepts: thread pool, workers, jobs - Common patterns: parallel processing, error handling - Links to related documentation Closes partially #282 * docs(guides): add Troubleshooting guide for common issues Create TROUBLESHOOTING.md and TROUBLESHOOTING_KO.md covering: - Build issues: C++20, vcpkg, compiler, linker errors - Runtime issues: thread pool startup, deadlock, memory leaks - Performance issues: throughput, CPU usage, lock contention - Platform-specific issues: macOS, Windows, Linux Closes partially #282 * docs(advanced): add C++20 Concepts documentation Create CPP20_CONCEPTS.md and CPP20_CONCEPTS_KO.md documenting: - Available concepts: Callable, VoidCallable, JobType, PoolJob, etc. - Usage examples with code samples - Type traits: is_duration, is_future_like, callable_return_type - Compiler requirements for C++20 concepts - C++17 fallback behavior - Integration with common_system This documents recent C++20 concepts integration (commits dbc3363, e182091, 9122fa3) which previously lacked documentation. Closes partially #282 * docs: fix broken links and update documentation structure Fix 5 broken links in README.md: - docs/guides/USER_GUIDE.md -> docs/advanced/USER_GUIDE.md - docs/guides/API_REFERENCE.md -> docs/advanced/02-API_REFERENCE.md - docs/advanced/ARCHITECTURE.md -> docs/advanced/01-ARCHITECTURE.md - docs/guides/MIGRATION_GUIDE.md -> docs/advanced/MIGRATION.md - Add link to new C++20 Concepts documentation Update README_KO.md documentation section: - Add structured documentation sections matching English README - Update all documentation links to correct paths - Add links to new QUICK_START_KO and TROUBLESHOOTING_KO guides Closes #282
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
docs/guides/QUICK_START.mdfor 5-minute getting starteddocs/guides/TROUBLESHOOTING.mdfor common issues and solutionsChanges
Fixed Links (README.md)
docs/guides/USER_GUIDE.mddocs/advanced/USER_GUIDE.mddocs/guides/API_REFERENCE.mddocs/advanced/02-API_REFERENCE.mddocs/advanced/ARCHITECTURE.mddocs/advanced/01-ARCHITECTURE.mddocs/guides/MIGRATION_GUIDE.mddocs/advanced/MIGRATION.mdNew Documentation
README_KO.md Updates
Test plan
Closes #282