Skip to content

Clarify preview feedback path on contribution docs#418

Open
DicksonWu654 wants to merge 3 commits intosecurity-alliance:developfrom
DicksonWu654:codex/issue-59-vercel-preview
Open

Clarify preview feedback path on contribution docs#418
DicksonWu654 wants to merge 3 commits intosecurity-alliance:developfrom
DicksonWu654:codex/issue-59-vercel-preview

Conversation

@DicksonWu654
Copy link
Collaborator

@DicksonWu654 DicksonWu654 commented Mar 16, 2026

Closes #59

Summary

  • clarify the lightweight feedback path for contributors reviewing an existing PR
  • explain that the rendered preview is the Cloudflare Pages preview linked from the PR
  • explain that proofreading or feedback should be left on the PR itself, without opening a separate PR
  • update both the docs page and the synced root CONTRIBUTING file

Verification

  • pnpm exec markdownlint-cli2 docs/pages/contribute/contributing.mdx
  • node utils/sync-contributing.js
  • Claude CLI review of the final diff

@github-actions
Copy link

github-actions bot commented Mar 16, 2026

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
frameworks ✅ Ready (View Log) Visit Preview d9749fb

@DicksonWu654 DicksonWu654 changed the title Clarify Vercel preview feedback path on contribution docs Clarify preview feedback path on contribution docs Mar 16, 2026
@DicksonWu654 DicksonWu654 marked this pull request as draft March 16, 2026 03:59
@DicksonWu654
Copy link
Collaborator Author

Clarified the intent here in the contribution docs.

This issue is about contributor workflow, not a new site feature: the Cloudflare Pages link on a PR is only a rendered preview for review, and feedback should stay on the existing PR rather than opening a separate PR or expecting comments directly on the live site.

I updated both docs/pages/contribute/contributing.mdx and the synced root CONTRIBUTING.md to make that explicit.

Copy link
Collaborator Author

@DicksonWu654 DicksonWu654 left a comment

Choose a reason for hiding this comment

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

lgtm

@DicksonWu654
Copy link
Collaborator Author

@mattaereal I'm not 100% if I've addressed the original issue #59 - so feel free to edit / just close this issue if it doesn't

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.

Add a section about the possibility to comment on the live vercel deployment inside the contribution page

1 participant