Skip to content

[Issue #148] Adds a TypeScript format tab to schema docs - #404

Merged
widal001 merged 3 commits into
mainfrom
issue-148-add-ts-formats-to-website
Nov 7, 2025
Merged

widal001 merged 3 commits into
mainfrom
issue-148-add-ts-formats-to-website

Conversation

@widal001

@widal001 widal001 commented Nov 7, 2025 •

Copy link
Copy Markdown
Collaborator

Summary

Adds TypeScript tab to the "Formats" section of the docs for Types, Fields, Filters, and Models schemas.

Changes proposed

What was added, updated, or removed in this PR.

  • Adds a new optional tab section to SchemaFormatTabs for TypeScript
  • Adds that new tab to all of the schemas for which we have Zod schemas
  • Fixes the broken JSON schema link

Context for reviewers

Testing instructions, background context, more in-depth details of the implementation, and anything else you'd like to call out or ask reviewers. Explain how the changes were verified.

You can explore the tabs by going to: https://cg-pr-404.billy-daly.workers.dev/protocol/fields/custom-field/

Additional information

Screenshots, GIF demos, code examples or output to help show the changes working as expected.

Here's the TypeScript tab:

Screenshot 2025-11-07 at 2 06 40 PM

Here's the update JSON schema link. On the deployed site it's broken, and it previously always took users to https://commongrants.org/ (instead of using the base URL of the current site)

Screenshot 2025-11-07 at 2 06 56 PM

@github-actions github-actions Bot added website Issues related to the website typescript Issue or PR related to TypeScript tooling labels Nov 7, 2025
@github-actions

github-actions Bot commented Nov 7, 2025

Copy link
Copy Markdown
Contributor

🚀 Website Preview Deployed!

Preview your changes at: https://cg-pr-404.billy-daly.workers.dev

This preview will be automatically deleted when the PR is closed.

@widal001
widal001 merged commit a820985 into main Nov 7, 2025
5 checks passed
@widal001
widal001 deleted the issue-148-add-ts-formats-to-website branch November 7, 2025 19:15
@github-actions

github-actions Bot commented Nov 7, 2025

Copy link
Copy Markdown
Contributor

🗑️ Preview Cleaned Up

The preview for this PR has been automatically deleted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

typescript Issue or PR related to TypeScript tooling website Issues related to the website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[TS SDK] Add TypeScript tab to schema docs

1 participant