Skip to content

website(docs): revamp website docs to use new SDK and document new features - #36

Draft
AryanSharma48 wants to merge 5 commits into
mainfrom
docs/website-revamp
Draft

website(docs): revamp website docs to use new SDK and document new features#36
AryanSharma48 wants to merge 5 commits into
mainfrom
docs/website-revamp

Conversation

@AryanSharma48

Copy link
Copy Markdown
Owner

Description

This PR revamps the website documentation (website/src/app/page.tsx) to align with the new SmoothAPI SDK naming conventions and major features.

Specifically, this update:

  • Replaces deprecated API references (createResilientFetch, resilient_api, ResilientConfig) with their modern equivalents (createSmoothFetch, smooth_api, SmoothConfig).
  • Adds dedicated documentation blocks in the "Core Features" section for Request Deduplication and Request Timeouts.
  • Updates the "Configuration Options" table to include timeoutMs, timeout_ms, and deduplication.

Fixes # (Leave blank or add issue number if you created one)

Type of Change

Please check the option that applies:

  • 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.

@vercel

vercel Bot commented Aug 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
smooth-api Ready Ready Preview Aug 19, 2026 10:30pm

@coderabbitai

coderabbitai Bot commented Aug 19, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 0673f27b-8a49-4ffa-91dd-20f82d088d4c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@AryanSharma48
AryanSharma48 marked this pull request as ready for review August 19, 2026 22:26
@AryanSharma48
AryanSharma48 marked this pull request as draft August 19, 2026 22:27
@github-actions github-actions Bot added docs Improvements or additions to documentation examples website labels Aug 19, 2026
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 examples website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant