Skip to content

Commit 944ad94

Browse files
committed
Documenation generation instructions updated on CONTRIBUTING.md
1 parent 9d3896a commit 944ad94

File tree

1 file changed

+5
-25
lines changed

1 file changed

+5
-25
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -231,39 +231,19 @@ and push your branch. The push should cause the CI to re-check your PR's changes
231231
In order to generate the HTML documentation files locally, go to the root of this repo, and run:
232232
233233
```
234+
yarn
234235
yarn install
235-
yarn docgen
236+
yarn docgen devsite
236237
```
237238
238-
This will generate both js and node (client) reference docs. To just generate js
239-
docs, replace the last line with:
240-
241-
```
242-
yarn docgen:js
243-
```
244-
245-
To just generate node docs, replace the last line with:
246-
247-
```
248-
yarn docgen:node
249-
```
250-
251-
Files will be written to `scripts/docgen/html` - js docs will go into the `/js`
252-
subdirectory and node docs into the `/node` subdirectory.
239+
This will generate reference docs in `docs-devsite/`. Commit and push your the generated
240+
documentation changes to GitHub following the [PR submission guidelines](#submit). Your push
241+
to the remote repository should force any failing documentation checks to execute again.
253242
254243
**NOTE:** These files are formatted to be inserted into Google's documentation site, which adds some
255244
styling and navigation, so the raw files will be missing navigation elements and may not look
256245
polished. However, it should be enough to preview the content.
257246

258-
This process will generate warnings for files that are generated but not listed in the `toc.yaml`,
259-
or files that are in the `toc.yaml` but were not generated (which means something is missing in
260-
`index.d.ts`). If this happens during the JS documentation generation, it probably means either the
261-
`toc.yaml` or `index.d.ts` is incorrect. But in the Node process, some generated files not being
262-
found in `toc.yaml` are to be expected, since Node documentation is a subset of the full JS
263-
documentation.
264-
265-
Follow the [PR submission guidelines](#submit) above to submit any documentation changes.
266-
267247
[archive]: https://github.com/firebase/firebase-js-sdk/issues?utf8=%E2%9C%93&q=is%3Aissue
268248
[file-an-issue]: https://github.com/firebase/firebase-js-sdk/issues/new
269249
[firebase-google-group]: https://groups.google.com/forum/#!forum/firebase-talk

0 commit comments

Comments
 (0)