-
Notifications
You must be signed in to change notification settings - Fork 0
Replace generic contracts–related docs with HashStore/TableStore docs #1028
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Replace generic contracts–related docs with HashStore/TableStore docs #1028
Conversation
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)
Summary of ChangesHello @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
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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.
There was a problem hiding this 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.
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/ |
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thank you!
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
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]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
Additional notes (optional)
N/A