Skip to content

Add GitHub Pages demo site#53

Closed
bdtran2002 wants to merge 1 commit intomainfrom
pages-demo
Closed

Add GitHub Pages demo site#53
bdtran2002 wants to merge 1 commit intomainfrom
pages-demo

Conversation

@bdtran2002
Copy link
Copy Markdown
Owner

@bdtran2002 bdtran2002 commented Apr 27, 2026

Summary

  • add a lightweight static demo page under docs/ for the SudoFill GitHub Pages site
  • deploy that static site from a dedicated Pages workflow on pushes to main
  • link the live demo URL in the README so the repo points to the hosted page

Summary by CodeRabbit

  • New Features
    • Launched a live demo site for the SudoFill browser extension featuring a responsive, fully self-contained landing page showcasing temporary inboxes, signup autofill, and verification link support
    • Implemented automated GitHub Pages deployment workflow that keeps the demo site current with every commit to the main branch

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 27, 2026

📝 Walkthrough

Walkthrough

Introduces automated GitHub Pages deployment via new GitHub Actions workflow triggered on pushes to main. Creates a static landing-page HTML file in docs/index.html with responsive design and dark-mode styling. Updates README with a live demo link and documentation of the Pages deployment workflow.

Changes

Cohort / File(s) Summary
GitHub Pages Workflow
.github/workflows/pages.yml
New workflow file that automates deployment to GitHub Pages on main branch pushes, with minimal required permissions and concurrency controls.
Documentation Updates
README.md
Adds centered "Live demo" link and new "Demo site" section describing the GitHub Pages URL, HTML source location, and automated deployment workflow.
Landing Page
docs/index.html
Creates complete self-contained static landing page for the SudoFill extension with dark-mode styling, responsive grid layout, navigation, hero section with CTA buttons, highlights, how-it-works guide, repository links, and footer.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

Poem

🐰 A workflow springs to life with Pages so bright,
Static HTML dances in dark mode's light,
Docs folder hops to the web with delight,
README points the way to demo's new site! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and concisely describes the main change: adding a GitHub Pages demo site. It accurately reflects the primary objective of the pull request.
Description check ✅ Passed The description provides clear context about what was added (demo page, workflow, README link) and aligns with the PR objectives. While it doesn't follow the template checklist format, the content adequately explains the changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch pages-demo

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/index.html`:
- Around line 636-639: Replace the maintainer-facing sentence inside the <p>
element in docs/index.html with visitor-facing copy; locate the paragraph node
containing "Swap these URLs if you want a different GitHub organization or
release destination." and change it to a descriptive phrase for site visitors
(for example: "Source code, releases, and the Pages workflow that publishes this
site."). Ensure the new text is concise and customer-facing and update only the
text content of that <p> element.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: ae16f648-4970-4bdc-b168-f5d74b169fe2

📥 Commits

Reviewing files that changed from the base of the PR and between f4746f4 and 7133543.

📒 Files selected for processing (3)
  • .github/workflows/pages.yml
  • README.md
  • docs/index.html

Comment thread docs/index.html
Comment on lines +636 to +639
<p>
Swap these URLs if you want a different GitHub organization or release destination.
</p>
</div>
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Replace developer/template-instruction copy with visitor-facing text.

The line "Swap these URLs if you want a different GitHub organization or release destination." reads like a maintainer-facing note left in template content. Public landing-page visitors won't action this — replace with a visitor-oriented description (e.g., "Source code, releases, and the Pages workflow that publishes this site.").

✏️ Proposed fix
               <h2>Repository links</h2>
-              <p>
-                Swap these URLs if you want a different GitHub organization or release destination.
-              </p>
+              <p>Source, releases, and the workflow that publishes this site.</p>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<p>
Swap these URLs if you want a different GitHub organization or release destination.
</p>
</div>
<p>Source, releases, and the workflow that publishes this site.</p>
</div>
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/index.html` around lines 636 - 639, Replace the maintainer-facing
sentence inside the <p> element in docs/index.html with visitor-facing copy;
locate the paragraph node containing "Swap these URLs if you want a different
GitHub organization or release destination." and change it to a descriptive
phrase for site visitors (for example: "Source code, releases, and the Pages
workflow that publishes this site."). Ensure the new text is concise and
customer-facing and update only the text content of that <p> element.

@bdtran2002 bdtran2002 closed this Apr 27, 2026
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.

1 participant