Skip to content

docs: clarify how reference documentation is generated and updated - #10330

Open
phoekerson wants to merge 1 commit into
firebase:mainfrom
phoekerson:docs/9590-clarify-doc-contribution-process
Open

docs: clarify how reference documentation is generated and updated#10330
phoekerson wants to merge 1 commit into
firebase:mainfrom
phoekerson:docs/9590-clarify-doc-contribution-process

Conversation

@phoekerson

Copy link
Copy Markdown

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:

  • that reference docs are generated from TSDoc comments in each package's
    source code (with docs-devsite/ai.aimodel.md / AIModel as an example,
    as raised in the issue)
  • that files in docs-devsite/ are generated and must not be edited directly
  • the contributor workflow: edit the TSDoc comment, run yarn docgen:all,
    commit both the source change and the regenerated files
  • that the Typedoc/compat process only applies to the legacy compat API
    (also fixes a broken toc.yaml path that pointed to a directory that no
    longer exists)

Testing

Documentation-only change (CONTRIBUTING.md), no code affected. No changeset
needed per the contribution guidelines.

API Changes

None.

@phoekerson
phoekerson requested a review from a team as a code owner August 26, 2026 13:42
@changeset-bot

changeset-bot Bot commented Aug 26, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 173cd2f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread CONTRIBUTING.md
Comment on lines +209 to +211
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),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
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),

Comment thread CONTRIBUTING.md
Comment on lines +217 to +218
1. Edit the TSDoc comment on the relevant class, function, interface, or property in the
package's source code (`packages/<product>/src/...`).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using <package> instead of <product> is more consistent with the terminology used throughout this section (e.g., "package's source code").

Suggested change
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/...`).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Confusion around generated docs file ai.aimodel.md and where edits should be made

1 participant