[MINOR]: Adding guideline

[vibhatha]

This PR includes a minor clean-up and guideline addition for docs making.

[gemini-code-assist]

Summary of Changes

Hello @vibhatha, I'm Gemini Code Assist¹! 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 significantly refines the project's documentation infrastructure by introducing a robust Docusaurus setup and deployment guideline. This new resource standardizes best practices for publishing documentation to GitHub Pages, including detailed GitHub Actions workflows. Concurrently, a substantial cleanup effort has been undertaken, removing numerous deprecated documentation files to streamline and modernize the project's informational assets.

Highlights

• New Docusaurus Guideline Added: A comprehensive DOCS_GUIDELINE.md has been introduced, detailing standardized practices for Docusaurus setup, configuration, and deployment to GitHub Pages, including GitHub Actions workflows for production and PR previews.
• Deprecated Documentation Removed: A significant number of files under the docs_deprecated/ directory have been removed, indicating a major cleanup and restructuring of the project's documentation.
• Standardized Documentation Practices: The new guideline aims to standardize documentation creation and deployment, covering aspects like Node.js version enforcement, Docusaurus configuration, and common troubleshooting steps.

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. ↩

[github-actions]

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-01-21 17:03 UTC

[gemini-code-assist]

Code Review

This pull request introduces a new guideline for setting up Docusaurus documentation and removes a significant amount of deprecated documentation files. The new guideline is well-structured and provides valuable instructions for CI/CD setup.

My review focuses on the new docs/DOCS_GUIDELINE.md file. I've identified a critical security vulnerability in the proposed PR preview workflow due to the use of pull_request_target. I've also found a configuration error in the build script that would cause the workflow to fail, and an inconsistency in the AI agent prompt. Please see my detailed comments for suggestions on how to address these issues.

[gemini-code-assist]

Using pull_request_target with ref: ${{ github.event.pull_request.head.sha }} is a significant security risk. This combination allows running untrusted code from a pull request with access to repository secrets. A malicious actor could modify the build script in package.json to exfiltrate secrets, such as the GITHUB_TOKEN.

It is strongly recommended to use the pull_request trigger instead. This ensures the workflow runs with read-only permissions and without access to secrets.

If the ability to comment on PRs is essential, consider a safer pattern using two workflows (one on pull_request to build, and another on workflow_run to deploy and comment).

Suggested change

	pull_request_target:
	pull_request:

[gemini-code-assist]

The build_script is executed from the root of the repository. Since the Docusaurus project is in the docs/ subdirectory, npm run build will fail because it won't find package.json at the root. You should specify the project directory using the --prefix flag to ensure the build command runs in the correct directory.

Suggested change

	build_script: npm run build
	build_script: npm run build --prefix docs

[gemini-code-assist]

This part of the prompt correctly suggests using pull_request, which is more secure than pull_request_target. However, the YAML template provided for the PR preview workflow (lines 111-155) uses pull_request_target. Please ensure the template is updated to match this safer recommendation to maintain consistency and security.