Skip to content

Support toc generation in the api-documenter #4931

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

Merged
merged 6 commits into from
May 24, 2021
Merged

Conversation

Feiyang1
Copy link
Member

To generate a toc, use command api-documenter-fire toc -i temp -p "/docs/reference/js/v9". temp is the folder that contains all api.json files.

The command will create a file toc/toc.yaml. To change the output folder, use the flag -o.

@changeset-bot
Copy link

changeset-bot bot commented May 21, 2021

⚠️ No Changeset found

Latest commit: 679fa99

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 21, 2021

Binary Size Report

Affected SDKs

  • @firebase/database

    Type Base (a263827) Head (218503e) Diff
    browser 296 kB 296 kB +41 B (+0.0%)
    esm2017 265 kB 265 kB +41 B (+0.0%)
    main 299 kB 299 kB +41 B (+0.0%)
    module 296 kB 296 kB +41 B (+0.0%)
  • @firebase/database-exp

    Type Base (a263827) Head (218503e) Diff
    browser 246 kB 246 kB +41 B (+0.0%)
    main 278 kB 278 kB +41 B (+0.0%)
    module 246 kB 246 kB +41 B (+0.0%)
  • firebase

    Click to show 15 binary size changes.
    Type Base (a263827) Head (218503e) Diff
    firebase-analytics.js 35.8 kB 35.7 kB -16 B (-0.0%)
    firebase-app-check.js 22.2 kB 22.2 kB -34 B (-0.2%)
    firebase-app.js 21.8 kB 21.8 kB -42 B (-0.2%)
    firebase-auth.js 177 kB 177 kB -21 B (-0.0%)
    firebase-database.js 187 kB 187 kB -91 B (-0.0%)
    firebase-firestore.js 332 kB 332 kB -75 B (-0.0%)
    firebase-firestore.memory.js 267 kB 267 kB -63 B (-0.0%)
    firebase-functions.js 10.8 kB 10.8 kB +4 B (+0.0%)
    firebase-installations.js 19.3 kB 19.3 kB +5 B (+0.0%)
    firebase-messaging.js 41.0 kB 40.9 kB -100 B (-0.2%)
    firebase-performance-standalone.js 49.7 kB 49.6 kB -48 B (-0.1%)
    firebase-performance.js 38.3 kB 38.3 kB -6 B (-0.0%)
    firebase-remote-config.js 36.9 kB 36.9 kB +5 B (+0.0%)
    firebase-storage.js 41.6 kB 41.5 kB -56 B (-0.1%)
    firebase.js 889 kB 888 kB -368 B (-0.0%)

Test Logs

@google-oss-bot
Copy link
Contributor

google-oss-bot commented May 21, 2021

Size Analysis Report

Affected Products

No changes between base commit (a263827) and head commit (218503e).

Copy link
Contributor

@hiranya911 hiranya911 left a comment

Choose a reason for hiding this comment

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

Looks pretty good. Just a couple of suggestions.

@Feiyang1 Feiyang1 merged commit cc2132c into master May 24, 2021
@Feiyang1 Feiyang1 deleted the fei-documenter-toc branch May 24, 2021 23:03
@firebase firebase locked and limited conversation to collaborators Jun 24, 2021
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.

4 participants