Skip to content

docs: update generated reference styling#9031

Open
Ehesp wants to merge 6 commits into
mainfrom
reference-styling
Open

docs: update generated reference styling#9031
Ehesp wants to merge 6 commits into
mainfrom
reference-styling

Conversation

@Ehesp
Copy link
Copy Markdown
Member

@Ehesp Ehesp commented May 26, 2026

Add custom css overrides to the typedoc generated output to align with new docs

@gemini-code-assist
Copy link
Copy Markdown
Contributor

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 introduces custom styling to the project's TypeDoc-generated documentation to ensure it aligns with the updated documentation design. It includes the addition of a stylesheet and updates to the TypeDoc configuration to incorporate these styles and refine navigation links.

Highlights

  • Custom CSS Integration: Added a new CSS file to apply custom styling overrides to the TypeDoc generated documentation.
  • Configuration Updates: Updated typedoc.json to include the new custom CSS, adjust the title link, and add a documentation navigation link.
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 the 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 counterproductive. 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.

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
Contributor

@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 custom CSS stylesheet (docs/reference.css) to style the TypeDoc reference documentation and updates typedoc.json to apply this stylesheet, update the titleLink to /, and add a link to the main documentation. The review feedback suggests rounding high-precision decimal values in the lab() color variables within the new CSS file to improve readability and maintainability.

Comment thread docs/reference.css Outdated
Copy link
Copy Markdown
Collaborator

@mikehardy mikehardy left a comment

Choose a reason for hiding this comment

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

LGTM functionality wise and I trust your CSS a precise 100.000% more than mine so if you're happy with the CSS that works for me.

Typedoc publishes on release so it matches shipped code, and we're due for one shortly so we'll get to see this live soon but not immediately on this merge

@mikehardy mikehardy added the Workflow: Pending Merge Waiting on CI or similar label May 26, 2026
@mikehardy mikehardy closed this May 26, 2026
@mikehardy mikehardy reopened this May 26, 2026
@mikehardy
Copy link
Copy Markdown
Collaborator

close/open cycle to restart actions after github actions outage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Workflow: Pending Merge Waiting on CI or similar

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants