Skip to content

Conversation

josh-wong
Copy link
Member

@josh-wong josh-wong commented Sep 24, 2025

Description

This PR adds ScalarDB 3.12 docs to the docs folder as the latest version and moves the ScalarDL 3.11 docs to a versioned folder.

Staging site: https://68d3708d0c0162f14c41b1fa--animated-sundae-c9ae14.netlify.app/docs/latest/

Note

Moved the docs according to the Docusaurus versioning instructions.

Related issues and/or PRs

N/A

Changes made

  • English docs
    • Moved 3.11 docs to the versioned_docs/version-3.11 folder.
    • Added 3.12 docs to the docs folder, which is where the latest version of English docs lives.
    • Added release notes.
    • Updated the Release Support Policy.
  • Japanese docs
    • Moved 3.11 docs to the i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.11 folder.
    • Added 3.12 docs to the *i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current folder, which is where the latest version of Japanese docs lives.
    • Added release notes.
    • Updated the Release Support Policy.
  • Created dedicated sidebar navigation for 3.11 (versioned_sidebars/version-3.11-sidebars.json).
  • Added an announcement to the top of the docs site about the 3.11 release.

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

@josh-wong josh-wong self-assigned this Sep 24, 2025
@Copilot Copilot AI review requested due to automatic review settings September 24, 2025 03:52
@josh-wong josh-wong added the documentation Improvements or additions to documentation label Sep 24, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds ScalarDL 3.12 documentation to the docs folder as the latest version and moves the ScalarDL 3.11 docs to a versioned folder according to Docusaurus versioning instructions.

  • Adds comprehensive Japanese documentation for ScalarDL 3.11 version
  • Includes release notes, guides, and reference documentation
  • Creates versioned folder structure for documentation management

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

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 primarily focuses on updating the ScalarDL documentation to version 3.12. It involves adding comprehensive new content for ScalarDL HashStore and TableStore, which provide advanced functionalities for managing data authenticity. Concurrently, the previous 3.11 documentation has been systematically archived into a version-specific directory, adhering to Docusaurus versioning best practices. The changes also include important updates to release information, support policies, and refinements to various status codes and configuration guidelines to improve clarity and accuracy.

Highlights

  • ScalarDL 3.12 Documentation: New documentation for ScalarDL version 3.12 has been added, making it the latest version available.
  • ScalarDL 3.11 Documentation Versioning: The existing ScalarDL 3.11 documentation has been moved into a dedicated versioned folder, ensuring historical accuracy and proper version management.
  • New Getting Started Guides: Introduced new 'Get Started' guides for ScalarDL HashStore and ScalarDL TableStore, offering high-level abstractions for object, collection, and table authenticity management.
  • Updated Release Information: The release notes and release support policy have been updated to reflect the new 3.12 version and its corresponding support dates.
  • Enhanced Status Codes and Configuration Details: Several status codes across Auditor, Client, Common, and Ledger components have been updated or added, along with clarifications on ScalarDB configuration limitations related to coordinator write omission optimization.
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 introduces a lot of new documentation for ScalarDL 3.12 and versions the 3.11 documentation. The changes are extensive and well-structured. My main feedback is about a recurring formatting issue in the markdown files: the use of :::: for Docusaurus admonitions instead of the correct :::. This will cause rendering problems and should be fixed across all new and modified files. I've also pointed out a couple of minor typos in the release notes and a properties file. Overall, this is a great contribution to the documentation.

Copy link

@choplin choplin left a comment

Choose a reason for hiding this comment

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

LGTM!

@josh-wong josh-wong merged commit 5e87cd2 into main Sep 24, 2025
1 check passed
@josh-wong josh-wong deleted the prepare-version-3.12 branch September 24, 2025 04:23
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.

3 participants