Skip to content

Add live demo link to README#34

Open
DarshanCodes09 wants to merge 2 commits intoAOSSIE-Org:mainfrom
DarshanCodes09:main
Open

Add live demo link to README#34
DarshanCodes09 wants to merge 2 commits intoAOSSIE-Org:mainfrom
DarshanCodes09:main

Conversation

@DarshanCodes09
Copy link

@DarshanCodes09 DarshanCodes09 commented Feb 24, 2026

Hosted the index.html demo on GitHub Pages so users can view it without cloning the repository.

Addressed Issues:

Fixes #31

Screenshots/Recordings:

Not applicable

Additional Notes:

The live demo link has been added to the README.

Checklist

  • My PR addresses a single issue, fixes a single bug or makes a single improvement.
  • My code follows the project's code style and conventions
  • If applicable, I have made corresponding changes or additions to the documentation
  • My changes generate no new warnings or errors
  • I have read the Contribution Guidelines

AI Usage Disclosure

  • This PR does not contain AI-generated code at all.

Summary by CodeRabbit

  • Documentation
    • Added a "Live Demo" section to the README with a heading and a link (includes an emoji arrow and the demo URL).

Added a live demo section with a link to the project.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8142e10 and 776d1d3.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

The PR adds a new "Live Demo" section to README.md containing a link (with an emoji arrow) to the GitHub Pages–hosted demo URL for previewing the SocialShareButton without cloning the repository.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added a new "Live Demo" section with an emoji arrow and a link to the GitHub Pages demo URL. No code or API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A tiny hop to a page so bright,
A demo link glows in README light,
No cloning needed, just click and play,
I nibble bugs while you display,
Hooray — the demo's here today!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The pull request partially addresses issue #31 by adding a README link, but there is no evidence that the index.html demo was actually hosted on GitHub Pages. Verify that GitHub Pages hosting is configured for the repository and that the demo is accessible at the intended live URL before merging.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title directly and clearly describes the main change: adding a live demo link to the README file.
Out of Scope Changes check ✅ Passed The changes are narrowly scoped to adding a live demo link to README, which directly aligns with the stated objectives of issue #31.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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
Contributor

@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 `@README.md`:
- Around line 662-665: The Live Demo link currently points to a personal GitHub
Pages site (https://darshancodes09.github.io/SocialShareButton/); update the
README under the "Live Demo" section to point to the organization's GitHub Pages
(or a placeholder org-hosted URL) and/or add a note that the demo should be
hosted under the AOSSIE-Org account for long-term stability; coordinate moving
the deployed site to the AOSSIE-Org repository (or change the URL to
https://AOSSIE-Org.github.io/SocialShareButton/ once deployed) and replace the
existing personal URL in the README.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d73852d and 8142e10.

📒 Files selected for processing (1)
  • README.md

README.md Outdated
Comment on lines 662 to 665
## Live Demo

👉 https://darshancodes09.github.io/SocialShareButton/

Copy link
Contributor

@coderabbitai coderabbitai bot Feb 24, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check if GitHub Pages is configured and get repo details
# Using git and basic shell commands to inspect repo metadata

# First, check if this is the right repo
cd . && git remote -v | head -5

# Try to get basic info about the repo (if .github configs exist)
if [ -d ".github" ]; then
  echo "=== .github directory contents ==="
  find .github -type f | head -20
fi

# Check for deploy workflows that might indicate GitHub Pages
echo "=== Checking for deployment-related files ==="
find . -maxdepth 3 -name "*.yml" -o -name "*.yaml" | grep -E "(deploy|workflow|pages)" | head -10

# Look for any GitHub Pages configuration hints in the codebase
echo "=== Looking for Pages-related configuration ==="
rg -i "pages\|github\.io" --type md --max-count 10

Repository: AOSSIE-Org/SocialShareButton

Length of output: 419


🌐 Web query:

Is the URL https://darshancodes09.github.io/SocialShareButton/ currently live and accessible

💡 Result:

Yes. As of February 24, 2026, https://darshancodes09.github.io/SocialShareButton/ is live and accessible (it loads the “SocialShareButton Demo - Modern Social Sharing Component” page). [1]


The demo URL is live, but it's hosted on a personal GitHub Pages account rather than the organization's.

The URL https://darshancodes09.github.io/SocialShareButton/ is currently accessible, but note that it points to a personal GitHub Pages account (darshancodes09) rather than the AOSSIE-Org account. This creates a maintenance risk: if the account ownership changes or access is lost, the link will break. Consider discussing whether the demo should be hosted under the organization's GitHub Pages for long-term sustainability.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 662 - 665, The Live Demo link currently points to a
personal GitHub Pages site
(https://darshancodes09.github.io/SocialShareButton/); update the README under
the "Live Demo" section to point to the organization's GitHub Pages (or a
placeholder org-hosted URL) and/or add a note that the demo should be hosted
under the AOSSIE-Org account for long-term stability; coordinate moving the
deployed site to the AOSSIE-Org repository (or change the URL to
https://AOSSIE-Org.github.io/SocialShareButton/ once deployed) and replace the
existing personal URL in the README.

Copy link
Author

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

@DarshanCodes09, thank you for the clarification! That makes perfect sense.

You're absolutely right that external contributors don't have the permissions to configure GitHub Pages on the organization's repository. Hosting the demo from your fork is a practical and reasonable approach to provide a working demonstration for reviewers and users.

The maintainers can handle updating the GitHub Pages configuration and the README URL once this PR is merged. At that point, the URL can be updated from https://darshancodes09.github.io/SocialShareButton/ to https://AOSSIE-Org.github.io/SocialShareButton/ (or whichever URL the organization chooses to use).

This approach works well for now and provides immediate value. Great work on getting the demo online! 🎉


🧠 Learnings used
Learnt from: kpj2006
Repo: AOSSIE-Org/SocialShareButton PR: 1
File: src/social-share-button.js:10-11
Timestamp: 2025-12-21T12:11:23.512Z
Learning: SSR compatibility is important for the SocialShareButton library (src/social-share-button.js) since it's designed for public library usage across multiple frameworks including SSR environments.

Added a section for a live demo of the project.
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.

[FEATURE]: Host index.html Demo on GitHub Pages

1 participant