Skip to content

Web SDK Quickstart #430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 15 commits into from
Closed

Conversation

goosewin
Copy link
Collaborator

@goosewin goosewin commented May 26, 2025

Description

  • Introduces dedicated /examples page
  • Updates navigation:
    • moves "How Vapi works" into "Resources" section on the bottom
    • renames "Quickstart" page to "Dashboard"
  • Replaces "Make web call" with "Web SDK Quickstart", featuring:
    • installation steps
    • quickstart examples
      • Next.js
      • React + Vite
      • Vanilla JS
    • basic usage walkthrough

Testing Steps

  • Run the app locally using fern docs dev or navigate to preview deployment
  • Navigate to the new pages using the left sidebar
  • Make sure the new documentation is up to Vapi's standards

@goosewin goosewin requested a review from elizabethtrykin May 26, 2025 23:18
Copy link
Contributor

@goosewin
Copy link
Collaborator Author

goosewin commented May 27, 2025

TODO:

  • Move all examples other than Next.js / React out into separate pages (future)
  • Expand on "Basic Usage" section to cover more features exposed through the SDK

Copy link
Contributor

@goosewin goosewin marked this pull request as ready for review May 27, 2025 03:12
Copy link
Contributor

@elizabethtrykin
Copy link
Collaborator

I like this significantly more than the current web sdk page, but the true quickstart should be building a specific example.

@goosewin
Copy link
Collaborator Author

I like this significantly more than the current web sdk page, but the true quickstart should be building a specific example.

Addressed in 26591be

Copy link
Contributor

Copy link
Contributor

@goosewin goosewin changed the base branch from main to feature/examples-code May 30, 2025 18:49
Copy link
Contributor

@goosewin
Copy link
Collaborator Author

Going to combine into a single PR with other SDK quickstarts

@goosewin goosewin closed this May 30, 2025
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.

2 participants