Skip to content

docs: add Request Deduplication section and example to main README - #73

Merged
AryanSharma48 merged 1 commit into
AryanSharma48:mainfrom
Kaustav5505g:docs/add-request-deduplication-example
Oct 11, 2026
Merged

AryanSharma48 merged 1 commit into
AryanSharma48:mainfrom
Kaustav5505g:docs/add-request-deduplication-example

Conversation

@Kaustav5505g

@Kaustav5505g Kaustav5505g commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

Description

Added a dedicated Request Deduplication section and copy-pasteable code example to the main README.md to make the feature easily discoverable.

Fixes #31

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation/Website update (changes to READMEs, examples, inline comments, or the documentation website)

Checklist

Design & Parity

  • If this introduces a new configuration option or public API, I have implemented equivalent options/behavior in both TypeScript and Python packages.
  • The core packages remain dependency-free (no new external runtime dependencies added).
  • I have updated the relevant package-specific README.md or general documentation where necessary.
  • If applicable, I have updated the examples or website to reflect these changes.

Quality & Testing

  • I started the sandbox Express server (cd sandbox && npm install && npm start) in a separate terminal before running the tests.
  • TypeScript Package: I have run the TypeScript tests (npm install && npm run build && npm test inside packages/smooth-api-ts) and all tests passed.
  • Python Package: I have run the Python tests (pip install -e ".[dev]" && pytest inside packages/smooth-api-py) and all tests passed.
  • I have added new tests to cover my changes.
  • I have commented my code, particularly in hard-to-understand areas, and updated JSDoc/docstrings.

@github-actions github-actions Bot added the docs Improvements or additions to documentation label Oct 11, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Hi there! Thanks for your first pull request! We'll review it shortly.

While it's getting reviewed, feel free to join our Discord community for suggestions and chat.

@AryanSharma48 AryanSharma48 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, Thanks for the contribution @Kaustav5505g

@AryanSharma48
AryanSharma48 merged commit f836654 into AryanSharma48:main Oct 11, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation First-Time Contributor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Add Request Deduplication example to main README

2 participants