Skip to content

Chore: update website#66

Open
ricky9667 wants to merge 10 commits intomasterfrom
chore/update-website
Open

Chore: update website#66
ricky9667 wants to merge 10 commits intomasterfrom
chore/update-website

Conversation

@ricky9667
Copy link
Owner

This pull request introduces a new static website for the project, replacing the previous Jekyll-based GitHub Pages configuration. It adds a custom index.html landing page styled with Tailwind CSS, updates image assets and demo links in the README.md, and sets up a GitHub Actions workflow to automate deployment to GitHub Pages. The previous remote theme configuration is removed to reflect the new static site approach.

Website overhaul and deployment automation:

  • Added a fully custom index.html landing page using Tailwind CSS, featuring sections for introduction, features, community, and support, as well as updated screenshots and demo images.
  • Introduced a GitHub Actions workflow (.github/workflows/pages.yml) to automate building and deploying the static site to GitHub Pages on pushes to master or chore/update-website branches.
  • Removed the Jekyll remote theme configuration from _config.yml to disable the previous theme and support the new static site.

Documentation and asset updates:

  • Updated demo image links in the README.md to match new filenames and reflect the latest UI/feature demos.

Copilot AI review requested due to automatic review settings March 12, 2026 02:19
@codecov
Copy link

codecov bot commented Mar 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 53.76%. Comparing base (458a0af) to head (8471556).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #66   +/-   ##
=======================================
  Coverage   53.76%   53.76%           
=======================================
  Files          40       40           
  Lines        1183     1183           
  Branches       83       83           
=======================================
  Hits          636      636           
  Misses        516      516           
  Partials       31       31           

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

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR replaces the previous Jekyll-based GitHub Pages setup with a custom static landing page and adds an Actions workflow to deploy it to GitHub Pages.

Changes:

  • Add a new Tailwind-styled index.html landing page (hero, intro, features, community/support, footer).
  • Add a GitHub Actions workflow to publish index.html + assets/ to GitHub Pages.
  • Remove the prior Jekyll remote theme config and update README demo asset links.

Reviewed changes

Copilot reviewed 4 out of 11 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
index.html New static landing page using Tailwind CDN + updated sections and outbound links.
assets/ricky-hu-logo.png Adds/updates a logo asset referenced by the new landing page footer.
_config.yml Removes Jekyll remote theme configuration to reflect moving away from Jekyll.
README.md Updates demo image filenames/links to match new assets.
.github/workflows/pages.yml Adds automated deployment of the static site to GitHub Pages.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines +110 to +111
<img class="w-4/5 sm:w-2/3 mx-auto rounded-xl shadow-lg object-contain" src="assets/demo.gif"
alt="Hush Keyboard Demo" />
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

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

assets/demo.gif is used directly on the landing page; in this repo it’s ~22MB, which will significantly slow first load and increase data usage. Consider replacing large GIFs with compressed MP4/WebM (with a poster) and/or adding lazy-loading for below-the-fold media.

Suggested change
<img class="w-4/5 sm:w-2/3 mx-auto rounded-xl shadow-lg object-contain" src="assets/demo.gif"
alt="Hush Keyboard Demo" />
<video class="w-4/5 sm:w-2/3 mx-auto rounded-xl shadow-lg object-contain" autoplay muted loop playsinline controls
poster="assets/demo-poster.jpg" loading="lazy" aria-label="Hush Keyboard Demo">
<source src="assets/demo.webm" type="video/webm" />
<source src="assets/demo.mp4" type="video/mp4" />
Your browser does not support the video tag.
</video>

Copilot uses AI. Check for mistakes.
Comment on lines +194 to +196
<a href="https://hushtimer.app/" target="_blank"
class="text-gray-800 bg-white border-2 border-gray-800 font-bold rounded-full py-4 px-8 shadow-lg transform transition hover:scale-105 hover:bg-gray-800 hover:text-white duration-300 ease-in-out inline-flex items-center gap-2">
<span>HUSH Timer</span>
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

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

Links opened with target="_blank" should include rel="noopener noreferrer" to prevent reverse-tabnabbing. Please add the rel attribute here (and consistently for other external links on the page).

Copilot uses AI. Check for mistakes.
<meta name="keywords" content="" />
<meta name="author" content="" />
<link rel="icon" type="image/png" href="assets/icon.png" />
<link rel="stylesheet" href="https://unpkg.com/tailwindcss@2.2.19/dist/tailwind.min.css" />
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

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

The site loads Tailwind from an external CDN (unpkg) without Subresource Integrity. For supply-chain hardening, consider self-hosting the compiled CSS or adding SRI + crossorigin attributes so a compromised CDN response can’t inject arbitrary CSS/JS into the site.

Suggested change
<link rel="stylesheet" href="https://unpkg.com/tailwindcss@2.2.19/dist/tailwind.min.css" />
<link rel="stylesheet" href="https://unpkg.com/tailwindcss@2.2.19/dist/tailwind.min.css"
integrity="sha384-REPLACE_WITH_REAL_SRI_HASH_FOR_TAILWINDCSS_2_2_19" crossorigin="anonymous" />

Copilot uses AI. Check for mistakes.
@ricky9667 ricky9667 self-assigned this Mar 12, 2026
@ricky9667 ricky9667 added documentation Improvements or additions to documentation enhancement Developer enhancements or upgrades labels Mar 12, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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 enhancement Developer enhancements or upgrades

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants