Skip to content

Commit 4f55ae2

Browse files
authored
[Docs] Documentation generation instructions updated in CONTRIBUTING.md (#7881)
This change updates the CONTRIBUTING.md file to better instruct users how to generate reference docs. I noticed that the instructions to generate documentation was missing a command line argument. Additionally, upon review from @hsubox76, the documentation included instructions that were for the legacy compat docs, not the new modular docs
1 parent f5882cb commit 4f55ae2

File tree

1 file changed

+8
-32
lines changed

1 file changed

+8
-32
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -221,49 +221,25 @@ formatting guidelines. In your local build environment, please run the code form
221221
by executing the command `yarn format`. Once the code is formatted, commit the changes and push your
222222
branch. The push should cause the CI to re-check your PR's changes.
223223

224-
### Generating Documentation HTML Files
224+
# Generating Documentation HTML Files
225225

226226
If the Doc Change Check fails in your PR, it indicates that the documentation has not been generated
227-
correctly for the changes. In your local build environment, please run `yarn docgen devsite` to
228-
generate the documentation locally. Once the documentation has been generated, commit the changes
229-
and push your branch. The push should cause the CI to re-check your PR's changes.
230-
231-
In order to generate the HTML documentation files locally, go to the root of this repo, and run:
232-
233-
```
234-
yarn install
235-
yarn docgen
236-
```
237-
238-
This will generate both js and node (client) reference docs. To just generate js
239-
docs, replace the last line with:
227+
correctly for the changes. In your local build environment, please run the following commands in the
228+
root directory to generate the documentation locally:
240229

241230
```
242-
yarn docgen:js
231+
yarn
232+
yarn docgen devsite
243233
```
244234

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.
235+
This will generate reference docs in `docs-devsite/`. Commit and push the generated
236+
documentation changes to GitHub following the [PR submission guidelines](#submit). Your push
237+
to the remote repository should force any failing documentation checks to execute again.
253238

254239
**NOTE:** These files are formatted to be inserted into Google's documentation site, which adds some
255240
styling and navigation, so the raw files will be missing navigation elements and may not look
256241
polished. However, it should be enough to preview the content.
257242
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-
267243
[archive]: https://github.com/firebase/firebase-js-sdk/issues?utf8=%E2%9C%93&q=is%3Aissue
268244
[file-an-issue]: https://github.com/firebase/firebase-js-sdk/issues/new
269245
[firebase-google-group]: https://groups.google.com/forum/#!forum/firebase-talk

0 commit comments

Comments
 (0)