Skip to content

Conversation

@tomkis
Copy link
Collaborator

@tomkis tomkis commented Dec 12, 2025

Summary

A first draft of docs for client SDK.

Linked Issues

Solves #1617

Documentation

  • No Docs Needed:

If this PR adds new feature or changes existing. Make sure documentation is adjusted accordingly. If the docs is not needed, please explain why.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @tomkis, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request lays the groundwork for comprehensive TypeScript SDK documentation by replacing a minimal placeholder with a detailed, multi-page structure. It introduces dedicated sections covering fundamental concepts, architectural overview, API client usage, extension handling, and practical examples, all integrated into the main documentation navigation. This change aims to significantly enhance the clarity and accessibility of information for developers building custom UIs with the AgentStack TypeScript SDK.

Highlights

  • TypeScript SDK Documentation Structure: Establishes the initial documentation structure for the TypeScript SDK, replacing a placeholder with a detailed hierarchy of new documentation pages.
  • Placeholder Removal: Removes the previous 'client-sdk.mdx' placeholder file, which contained a 'Documentation Coming Soon' note.
  • New Documentation Pages: Introduces dedicated '.mdx' files for 'api-client', 'basic-concepts', 'examples', 'extensions', and 'getting-started' within the 'client-sdk' directory, providing specific content areas for the SDK.
  • Navigation Update: Integrates the new documentation pages into the 'docs.json' navigation, creating a structured 'Client SDK (Typescript)' group for improved discoverability and organization.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request lays the foundational structure for the TypeScript SDK documentation by adding several new markdown files and updating the site navigation. The changes are well-organized. My review includes suggestions to replace a placeholder description, fix a minor grammatical issue for clarity, and address a broken link to ensure the documentation is complete and navigable.

Signed-off-by: Tomas Weiss <[email protected]>
Signed-off-by: Tomas Weiss <[email protected]>
@tomkis tomkis requested a review from jenna-winkler December 15, 2025 12:06
@tomkis tomkis marked this pull request as ready for review December 15, 2025 12:06
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Dec 15, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Dec 29, 2025
@jenna-winkler jenna-winkler merged commit 940c8ae into main Dec 29, 2025
8 checks passed
@jenna-winkler jenna-winkler deleted the docs/ts-sdk-foundation branch December 29, 2025 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants