Skip to content

Conversation

@harley
Copy link
Contributor

@harley harley commented Sep 27, 2025

No description provided.

@gemini-code-assist
Copy link

Summary of Changes

Hello @harley, 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 improving the project's documentation by streamlining how release notes are communicated and enhancing the clarity and accuracy of the extension's architectural and operational flow descriptions. The changes aim to make it easier for users and developers to understand the project's lifecycle, components, and release history.

Highlights

  • Documentation Consolidation: The pull request consolidates and refines documentation related to release notes and the extension's operational flow. The manual docs/changelog.md has been removed in favor of an automated CHANGELOG.md managed by Release Please, and core documentation files like architecture.md and extension-flow.md have been updated for clarity and better cross-referencing.
  • Updated Release Notes Process: Information regarding release management has been updated across README.md and docs/README.md to reflect the use of Release Please for automated versioning and release notes, pointing users to the root CHANGELOG.md or GitHub Releases.
  • Enhanced Flow and Architecture Documentation: The docs/extension-flow.md has been significantly refactored to provide a clearer 'Lifecycle Overview' table, replacing the previous narrative list. docs/architecture.md now includes a cross-reference to the extension flow and updated 'Known Constraints' for improved accuracy.
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 does a great job of consolidating and improving the project's documentation. The move to an automated changelog process with release-please is a solid improvement, and removing the manual changelog cleans up the docs folder. The restructuring of extension-flow.md into a table with cross-references to architecture.md significantly improves clarity and navigability. I have one minor suggestion to make the cross-references in the new table clickable, which would further enhance the documentation's user experience.

Comment on lines +9 to +14
| Install or upgrade | Extension installed from source or Web Store | Background service worker | Seeds defaults and handles migrations (`architecture.md` → Runtime Components). |
| Host access granted | Chrome applies `manifest.ts` host permissions | Chrome / MV3 platform | Controls where the content script can run (`architecture.md` → Runtime Components). |
| Page activation | User opens a whitelisted URL | Content script | Fetches settings, checks URL against patterns, and, if allowed, initialises Mermaid (`architecture.md` → Data Flow Sequence). |
| Inline rendering | Mermaid blocks detected | Content script + Mermaid runtime | Injects managed containers, themes Mermaid, and caches SVG output (`architecture.md` → Mermaid Rendering & Downloads). |
| Settings changes | Options UI edits or resets settings | Options UI + shared settings utils | Saves updates through `saveSettings`; listeners reconcile state across surfaces (`architecture.md` → Settings Synchronisation). |
| Continuous updates | Chat adds new content or settings sync changes arrive | Content script | MutationObserver re-runs detection; storage listeners reapply activation rules (`architecture.md` → Settings Synchronisation). |

Choose a reason for hiding this comment

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

medium

The cross-references to architecture.md in the "Notes" column are very helpful. To improve navigability and for consistency with other links in the documentation, consider making them clickable markdown links.

Suggested change
| Install or upgrade | Extension installed from source or Web Store | Background service worker | Seeds defaults and handles migrations (`architecture.md` → Runtime Components). |
| Host access granted | Chrome applies `manifest.ts` host permissions | Chrome / MV3 platform | Controls where the content script can run (`architecture.md` → Runtime Components). |
| Page activation | User opens a whitelisted URL | Content script | Fetches settings, checks URL against patterns, and, if allowed, initialises Mermaid (`architecture.md` → Data Flow Sequence). |
| Inline rendering | Mermaid blocks detected | Content script + Mermaid runtime | Injects managed containers, themes Mermaid, and caches SVG output (`architecture.md` → Mermaid Rendering & Downloads). |
| Settings changes | Options UI edits or resets settings | Options UI + shared settings utils | Saves updates through `saveSettings`; listeners reconcile state across surfaces (`architecture.md` → Settings Synchronisation). |
| Continuous updates | Chat adds new content or settings sync changes arrive | Content script | MutationObserver re-runs detection; storage listeners reapply activation rules (`architecture.md` → Settings Synchronisation). |
| Install or upgrade | Extension installed from source or Web Store | Background service worker | Seeds defaults and handles migrations ([`architecture.md`](./architecture.md) → Runtime Components). |
| Host access granted | Chrome applies `manifest.ts` host permissions | Chrome / MV3 platform | Controls where the content script can run ([`architecture.md`](./architecture.md) → Runtime Components). |
| Page activation | User opens a whitelisted URL | Content script | Fetches settings, checks URL against patterns, and, if allowed, initialises Mermaid ([`architecture.md`](./architecture.md) → Data Flow Sequence). |
| Inline rendering | Mermaid blocks detected | Content script + Mermaid runtime | Injects managed containers, themes Mermaid, and caches SVG output ([`architecture.md`](./architecture.md) → Mermaid Rendering & Downloads). |
| Settings changes | Options UI edits or resets settings | Options UI + shared settings utils | Saves updates through `saveSettings`; listeners reconcile state across surfaces ([`architecture.md`](./architecture.md) → Settings Synchronisation). |
| Continuous updates | Chat adds new content or settings sync changes arrive | Content script | MutationObserver re-runs detection; storage listeners reapply activation rules ([`architecture.md`](./architecture.md) → Settings Synchronisation). |

@harley harley merged commit 8db720d into main Sep 27, 2025
1 check passed
@harley harley deleted the update-docs branch September 27, 2025 06:16
harley added a commit that referenced this pull request Sep 29, 2025
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.

2 participants