Skip to content

docs(policies): create policy queue combinations guide#533

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-529-create-policy-queue-combinations-guide
Feb 8, 2026
Merged

docs(policies): create policy queue combinations guide#533
kcenon merged 1 commit into
mainfrom
docs/issue-529-create-policy-queue-combinations-guide

Conversation

@kcenon

@kcenon kcenon commented Feb 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Owner

Closes #529

Summary

  • Create comprehensive docs/POLICY_QUEUE_GUIDE.md documenting the policy-based queue system
  • Cover all 3 policy dimensions: SyncPolicy (3 types), BoundPolicy (3 types), OverflowPolicy (5 types)
  • Include full compatibility matrix showing valid/invalid combinations
  • Provide 7 recommended combinations with use cases, trade-offs, and code examples
  • Document performance characteristics (throughput, latency, memory, thread scaling)
  • List 6 anti-patterns with explanations and fixes

Test Plan

  • Verify all code examples compile against current API
  • Cross-reference compatibility matrix with policy_queue.h comments
  • Review anti-patterns section for accuracy
  • Check all internal documentation links resolve correctly

@kcenon
docs(policies): create policy queue combinations guide (#529)
91a1c71 
Add comprehensive documentation for the policy-based queue system
covering SyncPolicy, BoundPolicy, and OverflowPolicy dimensions
with compatibility matrix, recommended combinations, performance
characteristics, code examples, and anti-patterns.
@kcenon kcenon mentioned this pull request Feb 8, 2026
Closed
6 tasks
@github-actions

github-actions Bot commented Feb 8, 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 b4f04b9 into main Feb 8, 2026
26 checks passed
@kcenon kcenon deleted the docs/issue-529-create-policy-queue-combinations-guide branch February 8, 2026 13:18
@kcenon kcenon mentioned this pull request Feb 8, 2026
Merged
4 tasks
kcenon added a commit that referenced this pull request Apr 13, 2026
@kcenon
docs(policies): create policy queue combinations guide (#529) (#533)
0b2abe2 
Add comprehensive documentation for the policy-based queue system
covering SyncPolicy, BoundPolicy, and OverflowPolicy dimensions
with compatibility matrix, recommended combinations, performance
characteristics, code examples, and anti-patterns.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Task] docs: Create policy queue combinations guide

1 participant

@kcenon