docs: clarify how reference documentation is generated and updated - #10330
docs: clarify how reference documentation is generated and updated#10330phoekerson wants to merge 1 commit into
Conversation
|
There was a problem hiding this comment.
Code Review
This pull request updates the CONTRIBUTING.md file to reflect the new documentation generation process using TSDoc, api-extractor, and api-documenter. The review feedback suggests minor improvements to the documentation, including using a relative link for the api-documenter path and replacing the placeholder <product> with <package> for consistency.
| The markdown files in `docs-devsite/` are generated by | ||
| [api-extractor](https://api-extractor.com/) and a customized version of | ||
| [api-documenter](https://github.com/firebase/firebase-js-sdk/tree/main/repo-scripts/api-documenter), |
There was a problem hiding this comment.
Using a relative link for api-documenter is more robust and consistent with other links in this document, as it avoids hardcoding the main branch URL of the repository.
| The markdown files in `docs-devsite/` are generated by | |
| [api-extractor](https://api-extractor.com/) and a customized version of | |
| [api-documenter](https://github.com/firebase/firebase-js-sdk/tree/main/repo-scripts/api-documenter), | |
| The markdown files in `docs-devsite/` are generated by | |
| [api-extractor](https://api-extractor.com/) and a customized version of | |
| [api-documenter](repo-scripts/api-documenter), |
| 1. Edit the TSDoc comment on the relevant class, function, interface, or property in the | ||
| package's source code (`packages/<product>/src/...`). |
There was a problem hiding this comment.
Using <package> instead of <product> is more consistent with the terminology used throughout this section (e.g., "package's source code").
| 1. Edit the TSDoc comment on the relevant class, function, interface, or property in the | |
| package's source code (`packages/<product>/src/...`). | |
| 1. Edit the TSDoc comment on the relevant class, function, interface, or property in the | |
| package's source code (`packages/<package>/src/...`). |
Fixes #9590
Discussion
As discussed in #9590, the "Updating Documentation" section of CONTRIBUTING.md
described the legacy Typedoc/compat process and conflicted with the
"Generating Documentation HTML Files" section below it. @hsubox76 invited
proposed improvements in the issue discussion.
This PR rewrites the section to explain:
source code (with
docs-devsite/ai.aimodel.md/AIModelas an example,as raised in the issue)
docs-devsite/are generated and must not be edited directlyyarn docgen:all,commit both the source change and the regenerated files
(also fixes a broken
toc.yamlpath that pointed to a directory that nolonger exists)
Testing
Documentation-only change (CONTRIBUTING.md), no code affected. No changeset
needed per the contribution guidelines.
API Changes
None.