Skip to content

Add yt-studio to documentation#1557

Merged
chongchonghe merged 3 commits into
developmentfrom
chong/docs/add-yt-studio
Jan 5, 2026
Merged

Add yt-studio to documentation#1557
chongchonghe merged 3 commits into
developmentfrom
chong/docs/add-yt-studio

Conversation

@chongchonghe

@chongchonghe chongchonghe commented Jan 4, 2026

Copy link
Copy Markdown
Contributor

Description

Add description of yt-studio to the documentation page.

Checklist

Before this pull request can be reviewed, all of these tasks should be completed. Denote completed tasks with an x inside the square brackets [ ] in the Markdown source below:

  • I have added a description (see above).
  • I have added a link to any related issues (if applicable; see above).
  • I have read the Contributing Guide.
  • I have added tests for any new physics that this PR adds to the code.
  • (For quokka-astro org members) I have manually triggered the GPU tests with the magic comment /azp run.

@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jan 4, 2026
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @chongchonghe, 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 enhancing the project's documentation by introducing yt-studio, a new web-based visualization tool, to the postprocessing guide. Concurrently, it improves the organization of documentation assets by relocating images to a dedicated media directory and refines the local documentation serving script to intelligently select an available port, streamlining the development and review process for documentation changes.

Highlights

  • New Visualization Tool Documentation: Added a new section to the postprocessing.md documentation detailing yt-studio, a web-based visualization tool for QUOKKA simulation data, including installation instructions, features, and a screenshot.
  • Documentation Asset Reorganization: Moved various image assets (e.g., quokka-favicon.svg, amr_grid_refinement.svg, volume_render_sphere.png, yt-studio-screenshot.jpg) into a new media subdirectory within docs/markdown to centralize and better organize documentation images.
  • Improved Local Documentation Server Script: Enhanced the docs_build_and_view.sh script to automatically find an available port for serving the documentation locally, preventing conflicts if a default port is already in use.
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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

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 the yt-studio visualization tool, reorganizes some media files, and improves a developer script for viewing the documentation. My review includes suggestions to use the standard PyPI installation command for yt-studio, points out a critical issue with a missing image file that would lead to a broken link, and suggests a refactoring of the port-finding logic in the shell script to enhance maintainability and robustness.

Comment thread docs/markdown/postprocessing.md
Comment thread docs/markdown/postprocessing.md
Comment thread scripts/bash/docs_build_and_view.sh
@chongchonghe chongchonghe enabled auto-merge January 4, 2026 04:42
@chongchonghe

Copy link
Copy Markdown
Contributor Author

@BenWibking This is ready for review.

@sonarqubecloud

sonarqubecloud Bot commented Jan 5, 2026

Copy link
Copy Markdown

@chongchonghe chongchonghe added this pull request to the merge queue Jan 5, 2026
@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Jan 5, 2026
Merged via the queue into development with commit 8a13ba9 Jan 5, 2026
48 checks passed
@chongchonghe chongchonghe deleted the chong/docs/add-yt-studio branch January 14, 2026 10:22
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 lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants