Skip to content

Commit 8c7539a

Browse files
committed
add docs:fork
This makes it easier to auto-generate docs when a contributor has forked the repo. See #439 (comment) for more information
1 parent 6fa717e commit 8c7539a

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,4 @@ set up.
8585
3. run `yarn lint` to confirm that code meets our style guide
8686
> If the lint check fails, run `yarn lint --fix` to automatically fix any issues.
8787
5. run `yarn docs` to rebuild the reference docs
88+
> If you've forked the repo, run `yarn docs:fork` instead. This will ensure the reference docs link to the firebaseextended/reactfire repository.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@
2323
"lint": "tsdx lint src test",
2424
"size": "size-limit",
2525
"analyze": "size-limit --why",
26-
"docs": "typedoc --options typedoc.json && markdown-toc -i docs/use.md"
26+
"docs": "typedoc --options typedoc.json && markdown-toc -i docs/use.md",
27+
"docs:fork": "typedoc --options typedoc.json --gitRemote upstream && markdown-toc -i docs/use.md"
2728
},
2829
"peerDependencies": {
2930
"firebase": "^9.0.0",

0 commit comments

Comments
 (0)