Skip to content

docs: add section for the spotlight sdk#1227

Merged
MathurAditya724 merged 4 commits intomainfrom
adi/docs/sdk
Jan 5, 2026
Merged

docs: add section for the spotlight sdk#1227
MathurAditya724 merged 4 commits intomainfrom
adi/docs/sdk

Conversation

@MathurAditya724
Copy link
Copy Markdown
Member

No description provided.

@vercel
Copy link
Copy Markdown

vercel bot commented Jan 2, 2026

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

Project Deployment Review Updated (UTC)
spotlightjs Ready Ready Preview, Comment Jan 5, 2026 11:30am

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive documentation for the Spotlight SDK, which allows developers to embed Spotlight's event buffering capabilities directly into their own HTTP servers instead of running a separate sidecar process.

Key changes:

  • New SDK documentation with API reference and complete working example
  • Configuration update to add SDK section to documentation sidebar

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
packages/website/src/content/docs/docs/sdk/index.mdx Comprehensive SDK documentation including installation, API reference, Hono.js integration example, event flow explanation, and buffer usage patterns
packages/website/astro.config.mjs Adds "SDK" section to documentation sidebar navigation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Member

@betegon betegon left a comment

Choose a reason for hiding this comment

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

looks great, thanks for adding. Let's see if we can do something about my comment so it's easier to use our sdk.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Member

@betegon betegon left a comment

Choose a reason for hiding this comment

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

love this.

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.

3 participants