Skip to content

Commit dcfd3c3

Browse files
committed
Add docgen all script and update documentation
1 parent 3883133 commit dcfd3c3

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

.github/workflows/check-docs.yml

+6-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
name: Doc Change Check (Run "yarn docgen devsite" if this fails)
15+
name: Doc Change Check (Run "yarn docgen:all" if this fails)
1616

1717
on: pull_request
1818

@@ -33,10 +33,12 @@ jobs:
3333
node-version: 20.x
3434
- name: Yarn install
3535
run: yarn
36-
- name: Run doc generation (devsite docs)
37-
run: yarn docgen devsite
36+
- name: Run doc generation
37+
run: yarn docgen:all
3838
- name: Check for changes in docs-devsite dir (fail if so)
3939
run: git diff --exit-code docs-devsite
40+
- name: Check for changes in toc dir (fail if so)
41+
run: git diff --exit-code toc
4042
- name: Reference documentation needs to be updated. See message below.
4143
if: ${{ failure() }}
42-
run: echo "Changes in this PR affect the reference docs. Run \`yarn docgen devsite\` locally to regenerate docs and add them to this PR."
44+
run: echo "Changes in this PR affect the reference docs. Run \`yarn docgen:all\` locally to regenerate docs and add them to this PR."

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -228,10 +228,10 @@ root directory to generate the documentation locally:
228228
229229
```
230230
yarn
231-
yarn docgen devsite
231+
yarn docgen:all
232232
```
233233
234-
This will generate reference docs in `docs-devsite/`. Commit and push the generated
234+
This will generate reference docs in `docs-devsite/` and `/toc`. Commit and push the generated
235235
documentation changes to GitHub following the [PR submission guidelines](#submit). Your push
236236
to the remote repository should force any failing documentation checks to execute again.
237237

package.json

+1
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
"test:saucelabs": "node scripts/run_saucelabs.js",
4141
"docgen": "ts-node-script scripts/docgen/docgen.ts",
4242
"docgen:compat": "node scripts/docgen-compat/generate-docs.js --api js",
43+
"docgen:all": "yarn docgen devsite && yarn docgen toc",
4344
"lint": "lerna run --scope @firebase/* lint",
4445
"lint:fix": "lerna run --scope @firebase/* lint:fix",
4546
"size-report": "ts-node-script scripts/size_report/report_binary_size.ts",

0 commit comments

Comments
 (0)