Skip to content

feat: Help Documentation with Request Batching (#496)#628

Merged
RUKAYAT-CODER merged 1 commit into
rinafcode:mainfrom
omonxooo-commits:feat/help-documentation-request-batching
May 31, 2026
Merged

feat: Help Documentation with Request Batching (#496)#628
RUKAYAT-CODER merged 1 commit into
rinafcode:mainfrom
omonxooo-commits:feat/help-documentation-request-batching

Conversation

@omonxooo-commits
Copy link
Copy Markdown
Contributor

Summary

Implements Help Documentation with Request Batching as described in issue #496.

Changes

  • src/lib/api/batch.tscreateBatcher utility: collects concurrent requests within a debounce window and sends them as a single batched call
  • src/app/api/help/route.ts — Edge API route accepting BatchRequest[], returning BatchResponse<HelpArticle>[] in one round-trip
  • src/hooks/useHelpDocumentation.ts — React hook backed by a shared batcher so multiple components share one network call
  • src/components/ui/HelpDocumentation.tsx — Collapsible article list with skeleton loading, error/retry, accessible markup, lucide icons, dark mode
  • src/lib/api/__tests__/batch.test.ts — 11 unit tests (all passing ✅)

Testing

  • All 11 unit tests pass
  • Lint clean on all new files
  • No regressions in existing functionality

Closes #496

- Add createBatcher utility (src/lib/api/batch.ts) that collects
  concurrent requests within a debounce window and sends them as a
  single batched POST, reducing network round-trips

- Add POST /api/help edge route that accepts BatchRequest[] and returns
  BatchResponse<HelpArticle>[] in one response; GET convenience endpoint
  also included

- Add useHelpDocumentation hook backed by a shared module-level batcher
  so multiple components mounting simultaneously share one network call

- Add HelpDocumentation component with collapsible articles, skeleton
  loading, error/retry UI, accessible markup, lucide icons, dark mode

- Add 11 unit tests covering batcher and hook (all passing)

Closes rinafcode#496
@omonxooo-commits omonxooo-commits force-pushed the feat/help-documentation-request-batching branch from 7cb18c6 to 37b1e95 Compare May 30, 2026 21:57
@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented May 30, 2026

@omonxooo-commits Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@RUKAYAT-CODER RUKAYAT-CODER merged commit 284153f into rinafcode:main May 31, 2026
3 of 6 checks passed
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.

feature Help Documentation : Request Batching

2 participants