diff --git a/README.md b/README.md index b8482c30a..0d8d0b0ab 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,20 @@ When a PR is created, a preview of those changes will be available after the [Pr The preview link can also be accessed directly using this pattern: `https://dev-design.va.gov/PR_NUMBER`. For example, `https://dev-design.va.gov/3435` where `3435` is the unique PR number visible in the PR title. +### Preview Troubleshooting + +#### Check the branch name + +A preview environment will generate only when the PR has been created from a direct branch from the main repository. It does not work if the PR was created from a fork. + +You can confirm if your PR was created from a fork by looking at the branch name at the top of the PR. If you see your Github username in front of your branch name, this means the PR was created from a fork and the preview will not generate. + +![The top of a PR showing the branch to be merged into main. There is a Github username at the front of a branch name which means the branch is from a fork](https://raw.githubusercontent.com/department-of-veterans-affairs/vets-design-system-documentation/refs/heads/main/src/images/readme/pr-branch-from-fork.png) + +If this was done because you don't have write access to this repository, you can request that access by submitting a support request in the #vfs-platform-support Slack channel. + +#### Re-running the preview workflow + If the preview has stopped working (for example if you're only seeing a 403 Forbidden error or similar), re-run the preview workflow by clicking "Details" next to the Preview check: ![A list of PR checks with an arrow pointing to the details link for the Preview workflow](https://raw.githubusercontent.com/department-of-veterans-affairs/vets-design-system-documentation/refs/heads/main/src/images/readme/pr-checks-preview-details.png) diff --git a/src/images/readme/pr-branch-from-fork.png b/src/images/readme/pr-branch-from-fork.png new file mode 100644 index 000000000..f40467a4f Binary files /dev/null and b/src/images/readme/pr-branch-from-fork.png differ