Skip to content

docs: rewrite AI SDK landing page to model Exa's reference DX#1667

Open
GreenFlux wants to merge 1 commit intodevelopfrom
docs/ai-sdk-realistic
Open

docs: rewrite AI SDK landing page to model Exa's reference DX#1667
GreenFlux wants to merge 1 commit intodevelopfrom
docs/ai-sdk-realistic

Conversation

@GreenFlux
Copy link
Copy Markdown
Contributor

@GreenFlux GreenFlux commented Apr 29, 2026

Summary

  • Restructure docs/guide/ai-sdk.md to follow Exa's developer-reference layout: Install → Setup → Quickstart → Example → Use cases → Safety → All options → TypeScript → Links.
  • Frame the SDK as framework-agnostic with Vercel AI SDK as the headline integration example.
  • Mark the SDK as beta/preview to set expectations against the still-placeholder API surface, and add the Safety and guardrails section called out in the HF-53 brief.

Closes HF-53.

Test plan

  • npm run docs:dev and verify the page renders under Guide → Integrations → HyperFormula AI SDK.
  • Confirm all internal links (built-in functions, custom functions) and external links (HubSpot beta form, GitHub, npm) resolve.
  • Sanity-check that no other guide pages are affected.

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.md into 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 generateText integration snippet, expands messaging around local/deterministic execution, and introduces a new Safety and guardrails section plus a table of planned createSpreadsheetTools options and TypeScript typing notes.

Reviewed by Cursor Bugbot for commit 810de4b. Bugbot is set up for automated code reviews on this repo. Configure here.

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.
@qunabu
Copy link
Copy Markdown

qunabu commented Apr 29, 2026

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 29, 2026

Deploy Preview for hyperformula-docs ready!

Name Link
🔨 Latest commit 810de4b
🔍 Latest deploy log https://app.netlify.com/projects/hyperformula-docs/deploys/69f1f98aa5826100082c680e
😎 Deploy Preview https://deploy-preview-1667--hyperformula-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@GreenFlux GreenFlux requested a review from sequba April 29, 2026 12:33
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 29, 2026

Performance comparison of head (810de4b) vs base (8b525cb)

                                     testName |   base |   head | change
------------------------------------------------------------------------
                                      Sheet A | 492.89 | 487.66 | -1.06%
                                      Sheet B | 156.36 | 156.74 | +0.24%
                                      Sheet T | 137.18 |  139.3 | +1.55%
                                Column ranges | 520.34 | 515.05 | -1.02%
Sheet A:  change value, add/remove row/column |  16.16 |     16 | -0.99%
 Sheet B: change value, add/remove row/column | 149.09 | 138.11 | -7.36%
                   Column ranges - add column |  163.5 | 154.06 | -5.77%
                Column ranges - without batch | 487.03 | 469.74 | -3.55%
                        Column ranges - batch | 122.86 | 120.58 | -1.86%

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.18%. Comparing base (8b525cb) to head (810de4b).

Additional details and impacted files

Impacted file tree graph

@@           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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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