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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 15 commits into from
Closed

Web SDK Quickstart #430

wants to merge 15 commits into from

Conversation

@goosewin
Copy link
Contributor

@goosewin goosewin commented May 26, 2025 •
edited
Loading

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
@github-actions
Copy link
Contributor

github-actions bot commented May 26, 2025

🌿 Preview your docs: https://vapi-preview-ddfa5ff4-c783-4bad-8de5-4239836779f5.docs.buildwithfern.com

@goosewin
Copy link
Contributor Author

goosewin commented May 27, 2025 •
edited
Loading

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

@github-actions
Copy link
Contributor

github-actions bot commented May 27, 2025

🌿 Preview your docs: https://vapi-preview-5d7c6392-1a86-4bcc-8e4a-a6dbb1b40f68.docs.buildwithfern.com

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

github-actions bot commented May 27, 2025

🌿 Preview your docs: https://vapi-preview-b7897127-8a61-481c-8f19-0cab1c3f53b9.docs.buildwithfern.com

@elizabethtrykin
Copy link
Contributor

elizabethtrykin commented May 27, 2025

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

@goosewin
Copy link
Contributor Author

goosewin commented May 27, 2025

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

Addressed in 26591be

@github-actions
Copy link
Contributor

github-actions bot commented May 27, 2025

🌿 Preview your docs: https://vapi-preview-3ad9d9b6-50d7-44b0-8cea-be5294ba5085.docs.buildwithfern.com

@github-actions
Copy link
Contributor

github-actions bot commented May 29, 2025

🌿 Preview your docs: https://vapi-preview-4cc5f340-d042-4cba-8149-8d7fd0717ed5.docs.buildwithfern.com

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

github-actions bot commented May 30, 2025

🌿 Preview your docs: https://vapi-preview-90f5cd84-18ab-4d5b-87ca-8e88209e828b.docs.buildwithfern.com

@goosewin
Copy link
Contributor Author

goosewin commented May 30, 2025

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

Reviewers

@elizabethtrykin elizabethtrykin Awaiting requested review from elizabethtrykin

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@goosewin @elizabethtrykin