Skip to content

Conversation

josh-wong
Copy link
Member

@josh-wong josh-wong commented Oct 14, 2025

Caution

We should avoid merging this PR until after Japanese docs for HashStore and TableStore have been published.

Description

This PR replaces generic contracts–related docs from the home page for version 3.12 and from the in-site notifications on the documentation site. The changes affect both English and Japanese content, updating feature cards, categories, and notifications to highlight ScalarDL HashStore and ScalarDL TableStore docs.

Staging site with the changes in this PR: https://68ee1096ebac91903d8eb8af--animated-sundae-c9ae14.netlify.app/

Related issues and/or PRs

Changes made

  • Updated the "Recent Features" and "Categories" sections in both English (src/components/Cards/3.12.tsx) and Japanese (src/components/Cards/ja-jp/3.12.tsx) to replace links and labels about generic contracts with new entries for HashStore, TableStore, SQL grammar, and data modeling. [1] [2] [3] [4]
  • Revised the notifications in src/data/notifications.js to promote new getting-started guides for HashStore and TableStore, and updated the blog post link to focus on migration from Amazon QLDB to ScalarDL, in both English and Japanese.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have updated the side navigation as necessary.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

Since generic contracts are part of HashStore and TableStore, which were introduced in 3.12, users don't need to refer to setting up generic contracts in another way. (Related commit: 61e454c)
@josh-wong josh-wong self-assigned this Oct 14, 2025
@josh-wong josh-wong added the documentation Improvements or additions to documentation label Oct 14, 2025
Copy link

Summary of Changes

Hello @josh-wong, 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 updates the ScalarDL documentation site by replacing outdated references to generic contracts with new, specific content for ScalarDL HashStore and ScalarDL TableStore. The changes ensure that the documentation's home page and in-site notifications for version 3.12 accurately reflect the latest features and guides, improving user experience for both English and Japanese audiences.

Highlights

  • Documentation Content Update: Replaced generic contracts-related documentation with specific content for ScalarDL HashStore and ScalarDL TableStore across the documentation site.
  • Feature Cards and Categories: Updated links and labels in the 'Recent Features' and 'Categories' sections for both English and Japanese documentation to highlight HashStore, TableStore, SQL grammar, and data modeling.
  • In-site Notifications: Revised in-site notifications to promote new getting-started guides for HashStore and TableStore, and adjusted the blog post link to focus on migration from Amazon QLDB to ScalarDL.
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

@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 updates the documentation site by replacing references to generic contracts with new content for ScalarDL HashStore and ScalarDL TableStore. The changes are applied to feature cards, categories, and notifications for both English and Japanese versions. The modifications are well-aligned with the goal of promoting the newer features. I've found one minor grammatical issue in an English notification message that should be corrected for clarity.

Copy link
Contributor

@jnmt jnmt left a comment

Choose a reason for hiding this comment

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

Thank you for the update. I left a confirmation. Also, for the quickstart category of the top page, I think "Getting started with ScalarDL HashStore" and "Getting started with ScalarDL TableStore" are better than the getting-started guide of the primitive Ledger, since we basically recommend them for most use cases. Can you update them as well?

Replaces the "Getting Started with ScalarDL Ledger" link and label with "Use ScalarDL HashStore" and adds a new entry for "Use ScalarDL TableStore" in both English and Japanese card components for version 3.12.
@josh-wong
Copy link
Member Author

@jnmt

... [F]or the quickstart category of the top page, I think "Getting started with ScalarDL HashStore" and "Getting started with ScalarDL TableStore" are better than the getting-started guide of the primitive Ledger, since we basically recommend them for most use cases. Can you update them as well?

I thought it might be a little weird to list the getting started tutorials for HashStore and TableStore twice on the home page (once in the "Recent features" section and again in the "Quickstart" section), but since we want to prioritize them over the primitive Ledger, I'm OK with that. I've added the links in b620ed5 and updated the staging site to reflect the recent commits: https://68ee1096ebac91903d8eb8af--animated-sundae-c9ae14.netlify.app/

@josh-wong josh-wong requested a review from jnmt October 14, 2025 09:03
@jnmt
Copy link
Contributor

jnmt commented Oct 14, 2025

@josh-wong

I thought it might be a little weird to list the getting started tutorials for HashStore and TableStore twice on the home page (once in the "Recent features" section and again in the "Quickstart" section)

That's a good point. After considering it again, I still prefer to list them twice since I feel the "Recent" category is orthogonal to others. But feel free to comment from other reviewers.

Copy link
Contributor

@jnmt jnmt left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants