Skip to content

Commit 3aa4f3d

Browse files
planetf1claude
andcommitted
docs: document fork PR limitation and fix markdownlint warnings
Fork PRs can't deploy because GITHUB_TOKEN lacks write access to upstream. Documented the workaround (manual dispatch or push to upstream). Fixed MD032 blank line warnings. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent ac7cfb0 commit 3aa4f3d

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

docs/PUBLISHING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ By default, validation issues are **reported but do not block** the
8181
deploy. This allows us to publish while resolving remaining issues.
8282

8383
To enable hard failures, use the `strict_validation` input:
84+
8485
- Via `workflow_dispatch`: check the "Fail the build if validation checks
8586
fail" checkbox.
8687
- To make it the permanent default: change `default: false` to
@@ -136,19 +137,25 @@ you're done testing.
136137

137138
Without the label, PRs only run build + validation (no deploy).
138139

140+
> **Fork PRs:** The deploy step requires write access to the upstream
141+
> repo. PRs from forks will build and validate successfully, but the
142+
> deploy will fail with a permission error. Use manual dispatch instead
143+
> (see below), or push the branch to the upstream repo.
144+
139145
### Manual dispatch
140146

141147
For more control (e.g. deploying to a custom branch):
142148

143149
1. Go to **Actions → Publish Documentation → Run workflow**.
144-
2. Select your feature branch.
150+
2. Select your feature branch (must exist on the upstream repo).
145151
3. Check **"Deploy even from a non-main context"**.
146152
4. Optionally change the target branch (defaults to `docs/preview`).
147153
5. Click **Run workflow**.
148154

149155
## Mintlify configuration
150156

151157
In the Mintlify dashboard (Git Configuration):
158+
152159
- **Staging environment** → branch: `docs/staging`
153160
- **Production environment** → branch: `docs/production`
154161

0 commit comments

Comments
 (0)