Skip to content

docs: deployment create#12

Merged
chrismclarke merged 2 commits intomainfrom
docs/deployment-management
Mar 4, 2026
Merged

docs: deployment create#12
chrismclarke merged 2 commits intomainfrom
docs/deployment-management

Conversation

@chrismclarke
Copy link
Copy Markdown
Contributor

Description

Summary of main changes

Screenshots / Videos

Include at least 1-2 screenshots of videos if visual changes

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, 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 focuses on enhancing the project's documentation by restructuring the navigation, adding a detailed guide for creating new deployments, and improving the initial onboarding experience. The changes aim to make the documentation more organized, comprehensive, and user-friendly, particularly for tasks related to deployment and localization.

Highlights

  • Documentation Structure Refinement: The main navigation metadata has been updated to better organize documentation sections, introducing a dedicated 'Deployment Management' category and renaming existing ones for improved clarity and consistency.
  • New Deployment Guide: Comprehensive documentation for creating new deployments has been added, detailing necessary database updates for country and locale codes, data mappings, and procedures for handling static assets.
  • Improved Onboarding: The main documentation landing page now includes a 'Getting Started' section with a direct link to the project's main README, enhancing discoverability and ease of access for new users.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • app/_meta.ts
    • Renamed 'Server & API' to 'Server Management'.
    • Added 'Deployment Management' to the navigation structure.
    • Removed 'Setup' and 'Applications' from the main navigation.
    • Renamed 'AI Best Practices' to 'AI'.
    • Corrected a typo from 'Destign System' to 'Design System'.
  • app/deployment/meta.ts
    • Created a new metadata file for the deployment section, defining 'Add New Deployment'.
  • app/deployment/new-deployment/page.mdx
    • Added a new documentation page outlining the process for creating a new deployment.
    • Included instructions for database updates related to country and locale codes.
    • Provided guidance on updating hardcoded data mappings for countries and locales.
    • Detailed steps for managing static assets, including downloading, compressing, and uploading flags.
  • app/page.mdx
    • Appended a 'Getting Started' section to the main documentation page.
    • Added a link to the main repository's README within the new 'Getting Started' section.
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
Copy Markdown

@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 adds documentation for creating a new deployment. The changes are a good start, but I've found a few areas for improvement in the new documentation page (app/deployment/new-deployment/page.mdx). My feedback includes suggestions to correct an invalid code snippet, improve instructional clarity, and use platform-agnostic file paths. I've also noted a missing newline character in app/page.mdx.

### Data updates
Finally provided mappings in the hardcoded app data mappings

`libs\data\deployments\countries.ts`.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

For cross-platform compatibility, it's best practice to use forward slashes (/) for file paths in documentation instead of backslashes (\).

`libs/data/deployments/countries.ts`.

@chrismclarke chrismclarke merged commit 0a667bb into main Mar 4, 2026
1 check passed
@chrismclarke chrismclarke deleted the docs/deployment-management branch March 4, 2026 01:46
@chrismclarke chrismclarke restored the docs/deployment-management branch March 4, 2026 01:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant