fix: making theme unique between sites

[jaredwray]

Please check if the PR fulfills these requirements

• Followed the Contributing and Code of Conduct guidelines.
• Tests for the changes have been added (for bug fixes/features) with 100% code coverage.

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
fix: making theme unique between sites

[gemini-code-assist]

Summary of Changes

Hello, 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 addresses an issue where theme preferences were shared across different sites, leading to inconsistent user experiences. By introducing a site-specific key for storing theme settings in localStorage, each site will now correctly remember and apply its own chosen theme, improving the overall user experience and stability of theme persistence.

Highlights

• Unique Theme Storage: Implemented a dynamic key for localStorage to store theme preferences, ensuring that each site maintains its own theme setting independently.
• Site-Specific Key Generation: The localStorage key is now generated using either the siteTitle or location.hostname, prefixed with 'docula:theme:', to guarantee uniqueness across different Docula sites.
• Consistent Theme Application: Updated both the initial theme loading in the header and the theme toggling logic in the scripts to use the new site-specific localStorage key.

Changelog

• templates/modern/includes/header.hbs
  • Introduced a themeKey variable to dynamically generate a unique key for localStorage based on siteTitle or location.hostname.
  • Updated the localStorage.getItem call to use the new themeKey for retrieving the theme mode.
• templates/modern/includes/scripts.hbs
  • Added a themeKey variable, similar to header.hbs, for site-specific localStorage access.
  • Modified the getMode function to retrieve the theme using the new themeKey.
  • Updated the event listener for theme toggling to save the theme preference using the themeKey in localStorage.

Activity

• No human activity has been recorded on this pull request yet.

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2f730de) to head (3a4a901).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #347   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            7         7           
  Lines         1486      1486           
  Branches       433       427    -6     
=========================================
  Hits          1486      1486           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[gemini-code-assist]

Code Review

This pull request introduces a good improvement by making the theme storage key unique for each site. However, I've found a couple of issues. First, the logic to generate the new theme key is duplicated in header.hbs and scripts.hbs. This can lead to maintenance problems in the future. I've added specific comments with suggestions to refactor this and avoid duplication. Second, and more critically, the end-to-end tests in test/theme-toggle.spec.ts have not been updated to use the new theme key format. They still reference the old 'theme' key, which will cause all theme-related tests to fail. Please update the tests to reflect the changes in this PR.

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d0d56ee46e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".