Skip to content

feat(docs): add GitHub Pages website#1

Merged
paul-cch merged 1 commit into
mainfrom
feat/github-pages-site
Feb 26, 2026
Merged

feat(docs): add GitHub Pages website#1
paul-cch merged 1 commit into
mainfrom
feat/github-pages-site

Conversation

@paul-cch
Copy link
Copy Markdown
Owner

Summary\n- add a dedicated static project website under docs/\n- add responsive styling and project overview content\n- link README to the GitHub Pages site URL\n\n## Verification\n- python3 -m unittest discover -s tests -p 'test_*.py' -v\n

Copilot AI review requested due to automatic review settings February 26, 2026 13:00
@paul-cch paul-cch merged commit dce384e into main Feb 26, 2026
8 checks passed
@paul-cch paul-cch deleted the feat/github-pages-site branch February 26, 2026 13:02
Copy link
Copy Markdown

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

Adds a simple GitHub Pages site under docs/ to provide a public-facing landing page for the project and links to it from the README.

Changes:

  • Added a static website (docs/index.html) with overview content and outbound links.
  • Added responsive styling (docs/styles.css) for the new site.
  • Added .nojekyll and linked the site URL from README.md.

Reviewed changes

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

File Description
docs/styles.css Introduces the site’s visual theme, layout, and responsive styling.
docs/index.html Adds the landing page markup and content for GitHub Pages.
docs/.nojekyll Disables Jekyll processing for GitHub Pages in docs/.
README.md Adds a link to the published GitHub Pages site.

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

Comment thread docs/index.html
Comment on lines +16 to +18
<a class="brand" href="./">WalBridge</a>
<a class="nav-link" href="https://github.com/paul-cch/WalBridge" target="_blank" rel="noreferrer">GitHub</a>
</nav>
Copy link

Copilot AI Feb 26, 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 tabnabbing via window.opener ("noreferrer" alone is not consistently enforced across all environments). Update the rel attribute accordingly for this link.

Copilot uses AI. Check for mistakes.
Comment thread docs/index.html
Comment on lines +27 to +29
<a class="btn btn-primary" href="https://github.com/paul-cch/WalBridge/releases/latest" target="_blank" rel="noreferrer">Get Latest Release</a>
<a class="btn btn-ghost" href="https://github.com/paul-cch/WalBridge" target="_blank" rel="noreferrer">View Source</a>
</div>
Copy link

Copilot AI Feb 26, 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 tabnabbing via window.opener. Update rel for these outbound links.

Copilot uses AI. Check for mistakes.
Comment thread docs/index.html
Comment on lines +61 to +63
<p>See animated transitions and multi-target sync in action.</p>
<a class="btn btn-primary" href="https://github.com/paul-cch/WalBridge/releases/download/v1.0.0/walbridge-demo.gif" target="_blank" rel="noreferrer">Open Demo GIF</a>
</section>
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

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

This link uses target="_blank" but is missing rel="noopener noreferrer", which can allow tabnabbing via window.opener. Add noopener (and keep noreferrer if desired).

Copilot uses AI. Check for mistakes.
Comment thread docs/index.html
Comment on lines +67 to +69
<p>Inspired by pywal, wallust, wpgtk, and Stylix.</p>
<p><a href="https://github.com/paul-cch/WalBridge/blob/main/LICENSE" target="_blank" rel="noreferrer">MIT License</a></p>
</footer>
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

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

This external link opens in a new tab (target="_blank") but lacks rel="noopener noreferrer", which is recommended to prevent tabnabbing via window.opener.

Copilot uses AI. Check for mistakes.
Comment thread docs/styles.css
Comment on lines +98 to +102
transition: transform 120ms ease, filter 120ms ease;
}

.btn:hover {
transform: translateY(-1px);
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

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

The button hover animation uses transform/transition; consider respecting user motion preferences by disabling or reducing these effects under @media (prefers-reduced-motion: reduce). This improves accessibility for users sensitive to motion.

Copilot uses AI. Check for mistakes.
Comment thread docs/index.html
<section class="panel">
<h2>Supported Targets</h2>
<div class="chips">
<span>SketchyBar</span><span>JankyBorders</span><span>Kitty</span><span>WezTerm</span><span>Alacritty</span><span>Ghostty</span><span>iTerm2</span><span>tmux</span><span>btop</span><span>Neovim</span><span>Yazi</span><span>Starship</span><span>OpenCode</span><span>HydroToDo</span>
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

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

All supported-target chips are inlined on a single long line, which makes future edits and diffs harder to review. Consider formatting each on its own line (or generating the list) to improve maintainability.

Suggested change
<span>SketchyBar</span><span>JankyBorders</span><span>Kitty</span><span>WezTerm</span><span>Alacritty</span><span>Ghostty</span><span>iTerm2</span><span>tmux</span><span>btop</span><span>Neovim</span><span>Yazi</span><span>Starship</span><span>OpenCode</span><span>HydroToDo</span>
<span>SketchyBar</span>
<span>JankyBorders</span>
<span>Kitty</span>
<span>WezTerm</span>
<span>Alacritty</span>
<span>Ghostty</span>
<span>iTerm2</span>
<span>tmux</span>
<span>btop</span>
<span>Neovim</span>
<span>Yazi</span>
<span>Starship</span>
<span>OpenCode</span>
<span>HydroToDo</span>

Copilot uses AI. Check for mistakes.
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