Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
anabellabuckvar authored Nov 20, 2023
1 parent e284540 commit b09c609
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions modules/oas-page-builder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@ npm run start -- --bundle /home/docsworker-xlarge/repos/cloud-docs/bundle.zip --

### (Required) Options

| Option | Description |
| ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| bundle | Path to the parsed bundle zip file. This should be the output of the parser and will be used to obtain build metadata about OpenAPI content pages. |
| output | Path to the directory that the OpenAPI content pages should be built to. Typically, this would be the same output `public/` directory of a Snooty frontend build. |
| redoc | Path to the local installation of Redoc CLI to use. This should point to the team's [fork of Redoc](https://github.com/mongodb-forks/redoc), with the target being a compiled JS file. |
| repo | Path to the parsed docs repo's directory. This is to ensure that OpenAPI content pages using local OAS files can be properly sourced and passed down as an argument to Redoc CLI. |
| site-url | URL to the docs repo's docs site. |
| Option | Description |
| ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| bundle | Path to the parsed bundle zip file. This should be the output of the parser and will be used to obtain build metadata about OpenAPI content pages. |
| output | Path to the directory that the OpenAPI content pages should be built to. Typically, this would be the same output `public/` directory of a Snooty frontend build. |
| redoc | Path to the local installation of Redoc CLI to use. This should point to the team's [fork of Redoc](https://github.com/mongodb-forks/redoc), with the target being a compiled JS file. |
| repo | Path to the parsed docs repo's directory. This is to ensure that OpenAPI content pages using local OAS files can be properly sourced and passed down as an argument to Redoc CLI. |
| siteUrl | URL to the docs repo's docs site. |

## Usage in Production

Expand Down

0 comments on commit b09c609

Please sign in to comment.