Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docgen all script and update documentation #8258

Merged
merged 6 commits into from
Jun 4, 2024

Conversation

dlarocque
Copy link
Contributor

Since we are now checking in the toc/toc.yaml file, we should have a check to ensure this file was updated, just as we do for docs-devsite.

@dlarocque dlarocque requested a review from a team as a code owner May 22, 2024 15:17
Copy link

changeset-bot bot commented May 22, 2024

⚠️ No Changeset found

Latest commit: a3e4f42

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

@google-oss-bot
Copy link
Contributor

google-oss-bot commented May 22, 2024

@google-oss-bot
Copy link
Contributor

google-oss-bot commented May 22, 2024

Copy link
Contributor

@hsubox76 hsubox76 left a comment

Choose a reason for hiding this comment

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

I just realized this outputs to a special toc/ folder which I think is confusing if you're looking at just the Github repo, why it's separated from all the docs. This part we can fix easily (adding the _ to the filename a little more complicated). You can add an --output option here https://github.com/firebase/firebase-js-sdk/blob/master/scripts/docgen/docgen.ts#L153 (see line 270 where we do it for the docgen call). toc is only generated for devsite so you don't have to do the whole ternary we use to get outputFolder in generateDocs, you can just hardcode "docs-devsite".

Come to think of it, you can also mv toc.yaml to _toc.yaml at the end of generateToc and then we don't need to change the google3 side script anymore.

@dlarocque dlarocque requested a review from a team as a code owner May 23, 2024 17:19
@dlarocque dlarocque requested a review from hsubox76 May 23, 2024 17:21
Copy link
Contributor

@hsubox76 hsubox76 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Copy link
Contributor

@egilmorez egilmorez left a comment

Choose a reason for hiding this comment

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

LG, thanks!

@dlarocque dlarocque merged commit 92a39b5 into master Jun 4, 2024
40 of 42 checks passed
@dlarocque dlarocque deleted the dlarocque/refdocs-script branch June 4, 2024 21:25
@firebase firebase locked and limited conversation to collaborators Jul 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants