Skip to content

Update Fogo Sessions integration docs with comprehensive SDK information - #15

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1760468854-update-fogo-sessions-sdk-docs
Open

devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1760468854-update-fogo-sessions-sdk-docs

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Update Fogo Sessions integration docs with comprehensive SDK information

Summary

Completely rewrote the Fogo Sessions integration documentation to provide comprehensive coverage of all four Fogo Sessions SDKs (React, Web, TypeScript, and Rust). The updated documentation now includes:

  • Clear SDK selection guide explaining when to use each SDK (React for web apps, Web for non-React browsers, TypeScript for Node.js, Rust for on-chain programs)
  • Updated React SDK API reference with new options like enableUnlimited and clarification that sponsor/paymasterUrl are now optional
  • New TypeScript SDK API reference documenting core functions like establishSession, replaceSession, revokeSession, etc.
  • New Web SDK documentation for browser session persistence using IndexedDB
  • New Rust SDK section for on-chain program integration with Anchor example
  • Practical code examples for all SDK types
  • Explicit guidance that most users should use the React SDK unless they're using Node.js or non-React frameworks

Review & Testing Checklist for Human

  • Verify SDK versions are current: React (v0.0.25), Web (v0.0.10), TypeScript (v0.0.16), Rust (v0.6.1) - these may need updating
  • Test the React SDK example code: Especially verify that enableUnlimited prop exists and sponsor/paymasterUrl are truly optional now (I removed them as required based on example code but this needs confirmation)
  • Validate Rust SDK documentation: The Rust section is based on limited information - the SessionValidator API and example code need verification against the actual crate API at docs.rs/fogo-sessions-sdk
  • Review TypeScript/Web SDK APIs: Check that function signatures and parameters match the actual published packages
  • Test code examples: Try running at least one example from each SDK section to ensure they work
  • Verify the docs render correctly: Visit https://docs.fogo.io/user-guides/integrating-fogo-sessions.html after deployment to ensure formatting and links work properly

Notes

  • The documentation build passes successfully (pnpm run docs:build)
  • This is a major rewrite that changes the structure significantly - review whether the new organization aligns with how you want developers to discover and choose between SDKs
  • The Rust SDK section is the most speculative since I had minimal source material - it may need the most revision
  • Requested by Connor Prussin (connor@dourolabs.xyz)
  • Devin session: https://app.devin.ai/sessions/b9b37fc0bbec40bda383c877c7bb3a0b

- Add detailed SDK selection guide for React, Web, TypeScript, and Rust
- Update React SDK API documentation with latest options (enableUnlimited, etc.)
- Add TypeScript SDK API reference with core functions
- Add Web SDK documentation for IndexedDB session persistence
- Add Rust SDK documentation for on-chain program integration
- Include practical examples for all SDK types
- Clarify that most users should use React SDK unless using Node or non-React frameworks

Co-Authored-By: Connor Prussin <connor@dourolabs.xyz>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

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.

0 participants