Skip to content

Fix compat doc script #5605

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Oct 12, 2021
Merged

Fix compat doc script #5605

merged 1 commit into from
Oct 12, 2021

Conversation

hsubox76
Copy link
Contributor

@hsubox76 hsubox76 commented Oct 11, 2021 •
edited
Loading

Recently changed TOC to point to new devsite path js/v8. This causes some trouble for the file name checker as it checks against the TOC names. Could do some string search/replace in both directions, or could just put the files into a v8 subdirectory, which seems easier.

Also needs CL:
https://critique-ng.corp.google.com/cl/402381226

@changeset-bot
Copy link

changeset-bot bot commented Oct 11, 2021

⚠️ No Changeset found

Latest commit: 2ed8ea8

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-cla google-cla bot added the cla: yes label Oct 11, 2021
@google-oss-bot
Copy link
Contributor

Binary Size Report

Affected SDKs

No changes between base commit (352cc26) and head commit (2b17b59).

Test Logs

Feiyang1
Feiyang1 reviewed Oct 12, 2021
View reviewed changes
scripts/docgen-compat/generate-docs.js
@@ -39,11 +39,12 @@ const { api: apiType, source: sourceFile } = yargs
.version(false)
.help().argv;

const docPath = path.resolve(`${__dirname}/html/${apiType}`);
const destinationDir = apiType === 'js' ? 'js/v8' : apiType;
Copy link
Member

Choose a reason for hiding this comment

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

Should node path be node/v8? Don't remember if we move it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, we've decided to leave node where it is, and it's implicitly v8. Node v9 is combined with browser v9, we just need to change the header and add some comments in APIs not supported in Node.

@Feiyang1 Feiyang1 assigned hsubox76 and unassigned Feiyang1 Oct 12, 2021
@hsubox76 hsubox76 merged commit 703ef77 into master Oct 12, 2021
@hsubox76 hsubox76 deleted the ch-docscriptfix branch October 12, 2021 21:02
@firebase firebase locked and limited conversation to collaborators Nov 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Feiyang1 Feiyang1 Feiyang1 approved these changes

@hiranya911 hiranya911 Awaiting requested review from hiranya911

Assignees

@hsubox76 hsubox76

Labels
cla: yes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hsubox76 @google-oss-bot @Feiyang1