Skip to content

docs(tutorials): add tutorials, FAQ and troubleshooting guide#661

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-659-enhance-documentation-with-tutorials
Apr 6, 2026
Merged

docs(tutorials): add tutorials, FAQ and troubleshooting guide#661
kcenon merged 1 commit into
mainfrom
docs/issue-659-enhance-documentation-with-tutorials

Conversation

@kcenon

@kcenon kcenon commented Apr 6, 2026

Copy link
Copy Markdown
Owner

Closes #659

Summary

  • Add 3 tutorials: thread pool, DAG, lock-free patterns
  • Add FAQ page with 10+ entries
  • Add troubleshooting guide
  • Update mainpage.dox with Learning Resources section

Test plan

  • Doxygen builds without warnings against the new pages
  • @ref cross-links resolve in mainpage Learning Resources section
  • CI passes on all platforms

Add Doxygen pages to help external developers ramp up faster:
- Thread pool tutorial covering basic vs typed pools, work-stealing,
  and sizing for CPU- and I/O-bound workloads
- DAG scheduling tutorial covering dependency definition, ordering
  guarantees, and best-effort error handling
- Lock-free queue tutorial covering MPMC vs SPSC selection, hazard
  pointers, and performance characteristics
- FAQ with the 10 most common integration questions
- Troubleshooting guide for deadlocks, leaks, hangs, and performance
- Learning Resources section in mainpage with cross-references
- Doxyfile updated to include the new pages

Closes #659
@github-actions

github-actions Bot commented Apr 6, 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 6de0642 into main Apr 6, 2026
27 checks passed
@kcenon kcenon deleted the docs/issue-659-enhance-documentation-with-tutorials branch April 6, 2026 02:54
kcenon added a commit that referenced this pull request Apr 13, 2026
Add Doxygen pages to help external developers ramp up faster:
- Thread pool tutorial covering basic vs typed pools, work-stealing,
  and sizing for CPU- and I/O-bound workloads
- DAG scheduling tutorial covering dependency definition, ordering
  guarantees, and best-effort error handling
- Lock-free queue tutorial covering MPMC vs SPSC selection, hazard
  pointers, and performance characteristics
- FAQ with the 10 most common integration questions
- Troubleshooting guide for deadlocks, leaks, hangs, and performance
- Learning Resources section in mainpage with cross-references
- Doxyfile updated to include the new pages

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

docs: Enhance documentation with tutorials and examples for external developers

1 participant