Host index.html demo on GitHub Pages and add live demo link to README#35
Host index.html demo on GitHub Pages and add live demo link to README#35Aarya-Chaudhari wants to merge 2 commits intoAOSSIE-Org:mainfrom
Conversation
📝 WalkthroughWalkthroughAdded a Live Demo section to the README that directs users to a GitHub Pages-hosted demo. This enables users to preview the SocialShareButton without cloning the repository, supporting the feature objective of providing accessible live demonstration access. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (2)
64-64: Format the URL as a named Markdown hyperlink.A named link is more idiomatic and resilient than a bare URL in documentation.
♻️ Proposed formatting improvement
-🔗 https://aarya-chaudhari.github.io/SocialShareButton/ +[🔗 Live Demo](https://aarya-chaudhari.github.io/SocialShareButton/)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 64, Replace the bare URL on the README (the line containing "https://aarya-chaudhari.github.io/SocialShareButton/") with a named Markdown link; for example, convert it to a descriptive anchor like "[Live demo](https://aarya-chaudhari.github.io/SocialShareButton/)" or "[Project demo](...)" so the link is presented as a named hyperlink rather than a raw URL.
63-65: Consider consolidating with the existing## Demosection (line 662).There is already a
## Demosection at line 662 that references the localindex.htmland a YouTube tutorial. Adding a separate## Live Demoat the top introduces two disconnected demo sections. Merging the hosted URL into the existing section would keep related information together.♻️ Proposed consolidation (at existing Demo section)
## Demo +🔗 [Live Demo](https://aarya-chaudhari.github.io/SocialShareButton/) + Open `index.html` in your browser to see all features. Tutorial: https://youtu.be/cLJaT-8rEvQ?si=CLipA0Db4WL0EqKMAnd remove the new standalone
## Live Demoblock added above## Features.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 63 - 65, Remove the standalone "## Live Demo" block and instead add the hosted URL (https://aarya-chaudhari.github.io/SocialShareButton/) into the existing "## Demo" section (heading "## Demo"), placing it alongside the local index.html and YouTube tutorial; ensure the "## Features" section remains directly after the consolidated Demo content and update the table of contents if present to reflect the single Demo entry.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 63-64: Replace the personal GitHub Pages URL in README.md (the
string "https://aarya-chaudhari.github.io/SocialShareButton/") with the
organization-hosted Pages URL once org Pages are enabled (e.g.,
"https://aossie-org.github.io/SocialShareButton/") and update the "Live Demo"
section accordingly; ensure GitHub Pages is enabled for the
AOSSIE-Org/SocialShareButton repository before changing the link so the README
points to a stable, org-controlled demo URL.
---
Nitpick comments:
In `@README.md`:
- Line 64: Replace the bare URL on the README (the line containing
"https://aarya-chaudhari.github.io/SocialShareButton/") with a named Markdown
link; for example, convert it to a descriptive anchor like "[Live
demo](https://aarya-chaudhari.github.io/SocialShareButton/)" or "[Project
demo](...)" so the link is presented as a named hyperlink rather than a raw URL.
- Around line 63-65: Remove the standalone "## Live Demo" block and instead add
the hosted URL (https://aarya-chaudhari.github.io/SocialShareButton/) into the
existing "## Demo" section (heading "## Demo"), placing it alongside the local
index.html and YouTube tutorial; ensure the "## Features" section remains
directly after the consolidated Demo content and update the table of contents if
present to reflect the single Demo entry.
| ## Live Demo | ||
| 🔗 https://aarya-chaudhari.github.io/SocialShareButton/ |
There was a problem hiding this comment.
Demo URL points to a personal fork — should be hosted under the organization.
The URL https://aarya-chaudhari.github.io/SocialShareButton/ is served from the contributor's personal GitHub account, not the AOSSIE-Org organization. Publishing this in the org's README creates a fragile dependency: the link will permanently break if the contributor ever removes their fork or disables GitHub Pages, and the org has no ability to recover it.
GitHub Pages should be enabled on the AOSSIE-Org/SocialShareButton repository itself, so the demo lives at a stable, org-controlled URL (e.g., https://aossie-org.github.io/SocialShareButton/).
🔗 Proposed fix once org Pages are configured
-🔗 https://aarya-chaudhari.github.io/SocialShareButton/
+🔗 [https://aossie-org.github.io/SocialShareButton/](https://aossie-org.github.io/SocialShareButton/)📝 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.
| ## Live Demo | |
| 🔗 https://aarya-chaudhari.github.io/SocialShareButton/ | |
| ## Live Demo | |
| 🔗 [https://aossie-org.github.io/SocialShareButton/](https://aossie-org.github.io/SocialShareButton/) |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 63 - 64, Replace the personal GitHub Pages URL in
README.md (the string "https://aarya-chaudhari.github.io/SocialShareButton/")
with the organization-hosted Pages URL once org Pages are enabled (e.g.,
"https://aossie-org.github.io/SocialShareButton/") and update the "Live Demo"
section accordingly; ensure GitHub Pages is enabled for the
AOSSIE-Org/SocialShareButton repository before changing the link so the README
points to a stable, org-controlled demo URL.
Thank you for the review. Since external contributors cannot deploy GitHub Pages for the organization repository, the demo is currently hosted from my fork to demonstrate functionality. The organization can later enable GitHub Pages on the main repository after merging this PR. |
1 participant
Addressed Issues:
Fixes #31
Screenshots/Recordings:
Additional Notes:
Hosted the existing index.html demo on GitHub Pages and added a live demo link to the README.
Changes Made
Created gh-pages branch for GitHub Pages deployment
Ensured index.html is accessible from the root for proper Pages hosting
Verified that all static assets (CSS/JS) load correctly in the hosted demo
Added a Live Demo section with the GitHub Pages URL in README.md
How to Test
Open the live demo link from the README
Verify the demo loads without cloning the repository
Check that styles, buttons, and configurations work as expected
Confirm no broken asset paths in the hosted version
Checklist
AI Usage Disclosure
Check one of the checkboxes below:
I have used the following AI models and tools: TODO
We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact.
Summary by CodeRabbit