Skip to content

Commit

Permalink
Derek feedback (stoplightio#2294)
Browse files Browse the repository at this point in the history
  • Loading branch information
pamgoodrich authored Nov 22, 2022
1 parent 2497ad9 commit d093c0a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/getting-started/dev-portal/dev-portal-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
- `projectId` - Find the Project ID in the Project Settings screen on Stoplight.
- `platformUrl` - By default, the URL is `https://stoplight.io/', but you can change it.
- `basePath` - Helps when using `router: 'history'` but docs are in a subdirectory like `https://example.com/docs/api`.
- `collapseTableOfContents` - Pass `true` to initially collapse ToC folders of articles and showing lists of endpoints for an API. This can help organize the ToC if you have a lot of content.
- `collapseTableOfContents` - Pass `true` to initially collapse ToC folders of articles and lists of endpoints for an API. This can help organize the ToC if you have a lot of content.
- `hideMocking` - Pass `true` to disable all mocking options and remove mention of the mock server.
- `hideTryIt` - Pass `true` to hide the [**Try It** feature](https://meta.stoplight.io/docs/platform/ZG9jOjM2OTM3Mjky-try-it).
- `tryItCorsProxy` - Pass the URL of a CORS proxy used to send requests to the Try It feature. The provided URL is pre-pended to the URL of an actual request.
- `tryItCredentialPolicy` - Use to fetch the credential policy for the Try It feature. Options are: `omit` (default), `include`, and `same-origin`.
- `router` - Determines how navigation should work:
- `history` - (Default) Uses the HTML5 history API to keep the UI in sync with the URL.
- `hash` - Uses the hash portion of the URL (example: `window.location.hash`) to keep the UI in sync with the URL.
- `hash` - Uses the hash portion of the URL to keep the UI in sync with the URL.
- `memory` - Keeps the history of your "URL" in memory (doesn't read or write to the address bar).
- `static` - Renders using the StaticRouter which can help render pages on the server.
2 changes: 1 addition & 1 deletion docs/getting-started/elements/elements-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
- `logo` - URL to an image that displays as a small square logo next to the title, above the table of contents.
- `router` - Determines how navigation should work:
- `history` - (default) uses the HTML5 history API to keep the UI in sync with the URL.
- `hash` - uses the hash portion of the URL (example: `window.location.hash`) to keep the UI in sync with the URL.
- `hash` - uses the hash portion of the URL to keep the UI in sync with the URL.
- `memory` - keeps the history of your "URL" in memory (doesn't read or write to the address bar).
- `static` - renders using the StaticRouter which can help render pages on the server.

2 changes: 1 addition & 1 deletion docs/guides/great-api-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Elements groups them by tags and uses their summary in the sidebar, then shows o

### Sample Code

Some folks have built their own API Client code, also known as Software Development Kits ("SDKs"). These are sometimes hand-crafted, and sometimes automatically generated from OpenAPI too.
Some folks have built their own API Client code, also known as Software Development Kits ("SDKs"). These are sometimes hand-crafted and sometimes are automatically generated from OpenAPI.

Elements generates sample code for you in curl and other popular programming languages. In the future, Elements may integrate [custom SDK templates](https://github.com/stoplightio/elements/discussions/1138) for those who already have their own SDKs.

Expand Down

0 comments on commit d093c0a

Please sign in to comment.