Skip to content

DOCS.md

Latest commit

 

History

History
37 lines (27 loc) · 1.89 KB

DOCS.md

File metadata and controls

37 lines (27 loc) · 1.89 KB

Docs

Prerequisites

To deploy the switchboard-on-demand docs site, you will need to install the Firebase CLI and connect your account.

curl -sL https://firebase.tools | upgrade=true bash

After logging in (using firebase login), you will also need to make sure that your Firebase account has access to the switchboard-docs project:

❯ firebase projects:list
✔ Preparing the list of your Firebase projects
┌────────────────────────┬────────────────────────┬────────────────┬──────────────────────┐
│ Project Display Name   │ Project ID             │ Project Number │ Resource Location ID │
├────────────────────────┼────────────────────────┼────────────────┼──────────────────────┤
│ Switchboard Docs       │ switchboard-docs       │ 659732266249   │ [Not specified]      │
└────────────────────────┴────────────────────────┴────────────────┴──────────────────────┘

If access is needed, contact Mitch or Jack.

Generate / Deploy Site

To deploy the docs for the switchboard-on-demand Rust SDK, simply run the following script:

# Generates the docs site and opens locally.
pnpm docgen --open

# Generates the docs site and tries to deploy to Firebase.
#
# Note that you will need to be logged into the Firebase CLI (See above).
pnpm docgen:deploy