-
Notifications
You must be signed in to change notification settings - Fork 897
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
Conversation
|
Size Report 1Affected ProductsNo changes between base commit (872e6f6) and merge commit (288c64c).Test Logs |
Size Analysis Report 1Affected ProductsNo changes between base commit (872e6f6) and merge commit (288c64c).Test Logs |
There was a problem hiding this 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.
dcfd3c3
to
3186c59
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
66489a2
to
d65e490
Compare
d65e490
to
a3e4f42
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LG, thanks!
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 fordocs-devsite
.