Skip to content

Conversation

josh-wong
Copy link
Member

Description

This PR removes all sidebar links related to generic contracts from both the English and Japanese documentation navigation in the sidebars.js file, which contains the latest version (3.12) of the docs. Since generic contracts are part of ScalarDL HashStore and ScalarDL TableStore, which were introduced in 3.12, users don't need to refer to setting up generic contracts in another way.

Note

As discussed:

  • The actual docs will continue to exist since users may need to reference those docs. However, those docs will be marked as deprecated in another PR.
  • The generic contract–related docs are hidden when searching the latest version (3.12) of the docs. This was achieved by excluding those docs from being crawled in Algolia DocSearch.

Related issues and/or PRs

N/A

Changes made

  • English documentation:
    • Removed links for "Use Generic Contracts", "Use Table-Oriented Generic Contracts", and "Write an Application with Generic Contracts" from the "How-to Guides" sections. [1] [2]
    • Removed the "Generic Contracts" reference from the "Reference" section.
  • Japanese documentation:
    • Removed links for "汎用コントラクトを使用" (Use Generic Contracts), "テーブル指向汎用コントラクトの使用" (Use Table-Oriented Generic Contracts), and "汎用コントラクトを用いたアプリケーションを作成" (Write an Application with Generic Contracts) from the "How-to Guides" sections. [1] [2]
    • Removed the "汎用コントラクト" (Generic Contracts) reference from the "Reference" section.

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.
@josh-wong josh-wong requested review from feeblefakie and jnmt October 9, 2025 03:31
@josh-wong josh-wong self-assigned this Oct 9, 2025
@josh-wong josh-wong added the sidebar navigation Updates to the sidebar navigation label Oct 9, 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 PR removes generic contracts-related documentation links from the 3.12 sidebar navigation in both English and Japanese versions of the documentation. This change reflects that generic contracts are now implicitly covered by ScalarDL HashStore and TableStore, making standalone setup guides for generic contracts unnecessary for the latest version. The underlying documentation pages will persist but will be deprecated in a subsequent PR and are already excluded from search results for version 3.12.

Highlights

  • Intent: This pull request aims to remove generic contracts-related documentation links from the 3.12 sidebar navigation in both English and Japanese. This is because generic contracts are now integrated into ScalarDL HashStore and TableStore, making separate documentation for their setup redundant for the latest version. The actual documentation pages will remain but will be marked as deprecated in a future PR, and they are already excluded from search results for version 3.12.
  • Changes: The sidebars.js file has been modified to remove specific entries from the sidebar navigation. In the English documentation, links for 'Use Generic Contracts', 'Use Table-Oriented Generic Contracts', 'Write an Application with Generic Contracts' (from 'How-to Guides'), and 'Generic Contracts' (from 'Reference') have been removed. Similarly, in the Japanese documentation, the corresponding links for '汎用コントラクトを使用', 'テーブル指向汎用コントラクトの使用', '汎用コントラクトを用いたアプリケーションを作成', and '汎用コントラクト' have been removed.
  • Reviewer Activity: No specific reviewer activity was provided in the context.
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

Thank you for this contribution. The changes to remove the generic contracts-related documentation links from the sidebar for version 3.12 are clear and well-justified in the pull request description. The modifications in sidebars.js are consistent for both the English and Japanese documentation. I've reviewed the changes and they look good. Great job!

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!

@josh-wong josh-wong merged commit 61e454c into main Oct 10, 2025
1 check passed
@josh-wong josh-wong deleted the remove-generic-contracts-docs-from-sidebar-in-3.12 branch October 10, 2025 01:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

sidebar navigation Updates to the sidebar navigation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants