Conversation
Restructure the AI SDK guide to follow Exa's developer-reference layout (Install, Setup, Quickstart, Example, Use cases, Safety, Options, Links) and frame the SDK as framework-agnostic with Vercel AI SDK as the headline integration example. Mark the SDK as beta to set expectations against the placeholder API surface, and add a Safety and guardrails section per the HF-53 brief.
Contributor
|
Task linked: HF-53 Create landing pages for AI toolchains |
✅ Deploy Preview for hyperformula-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Performance comparison of head (810de4b) vs base (8b525cb) |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1667 +/- ##
========================================
Coverage 97.18% 97.18%
========================================
Files 174 174
Lines 15086 15086
Branches 3223 3223
========================================
Hits 14662 14662
Misses 424 424 🚀 New features to boost your workflow:
|
3 tasks
sequba
pushed a commit
that referenced
this pull request
May 11, 2026
…#1669) ## Summary - Reframe [docs/guide/ai-sdk.md](docs/guide/ai-sdk.md) around a HyperFormula + Vercel AI SDK integration with a single integrated `generateText` example as the only code block. - Mark the SDK as an unreleased prototype via a top-of-page warning callout, and add a prominent waitlist CTA with the existing HubSpot form. - Rename the sidebar entry in [docs/.vuepress/config.js](docs/.vuepress/config.js) to "Integration with Vercel AI SDK". Closes [HF-53](https://app.clickup.com/t/86c7upjar). Supersedes #1667. ## Test plan - [ ] `npm run docs:dev`, open `/guide/ai-sdk`, confirm sidebar reads "Integration with Vercel AI SDK" and the prototype callout sits above the fold. - [ ] Confirm the Vercel `generateText` snippet is the only code block and the page no longer carries Install / Setup / All options / TypeScript sections. - [ ] Click the waitlist link and external links (Vercel docs, GitHub, npm); click internal links to built-in / custom functions guides. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: documentation-only changes (sidebar label and guide content) with no runtime or API behavior impact. > > **Overview** > Reframes `docs/guide/ai-sdk.md` as **HyperFormula tools for the Vercel AI SDK**, adding a top-of-page *prototype/not-yet-released* warning, a single `generateText`-based example, updated use cases, and a waitlist CTA plus relevant links. > > Renames the guide’s sidebar entry in `docs/.vuepress/config.js` from “HyperFormula AI SDK” to **“Integration with Vercel AI SDK”**. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 3eb3e85. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> Co-authored-by: Joseph Petty <greenflux@Josephs-MacBook-Pro.local>
Contributor
|
Closing in favor of #1669 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes HF-53.
Test plan
npm run docs:devand verify the page renders under Guide → Integrations → HyperFormula AI SDK.Note
Low Risk
Documentation-only changes with no runtime or API behavior modifications; main risk is minor user confusion if previewed APIs/options diverge from implementation.
Overview
Rewrites
docs/guide/ai-sdk.mdinto a more complete landing page with a clear flow (Install → Setup → Quickstart → Example → Use cases → Safety → Options → TS → Links) and positions the AI SDK as beta/preview.Adds a concrete Vercel AI SDK
generateTextintegration snippet, expands messaging around local/deterministic execution, and introduces a new Safety and guardrails section plus a table of plannedcreateSpreadsheetToolsoptions and TypeScript typing notes.Reviewed by Cursor Bugbot for commit 810de4b. Bugbot is set up for automated code reviews on this repo. Configure here.