Skip to content

Commit

Permalink
Merge 0b6bdd9 into 74ebba6
Browse files Browse the repository at this point in the history
  • Loading branch information
stephffuller committed Aug 12, 2020
2 parents 74ebba6 + 0b6bdd9 commit fa5f923
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Hi! We're really excited that you are interested in contributing to ReDoc. Befor
- [Pull Request Guidelines](#pull-request-guidelines)
- [Development Setup](#development-setup)
- [Project Structure](#project-structure)
- [Style Guide](#style-guide)

## Issue Reporting Guidelines
- Before filing a new issue, try to make sure your problem doesn’t already exist.
Expand Down Expand Up @@ -94,3 +95,7 @@ There are some other scripts available in the `scripts` section of the `package.
- **`src/utils`**: utility functions
- **`src/styled-components.ts`**: - reexports styled-components with proper typescript annotations using theme
- **`src/theme.ts`**: - default theme (colors, fonts, etc) used by all the components

## Style Guide

Please find our style-guide [here](/style-guide).
44 changes: 44 additions & 0 deletions docs/FAQ
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Redocly Frequently Asked Questions

- [How do I enable the Console API?](#how-do-i-enable-the-console-api)
- [Redoc Community Edition is not rendering my large json file smoothly.](#redoc-community-edition-is-not-rendering-my-large-json-file-smoothly)
- [Does Redocly support webhooks with OpenAPI 3.1?](#does-redocly-support-webhooks-with-openapi-31)
- [How do I adjust the theme settings on a page, such as color, line spacing, and fonts?](#how-do-i-adjust-the-theme-settings-on-a-page-such-as-color-line-spacing-and-fonts)
- [Where can I locate Docker images for Redocly and redoc.cli?](#where-can-i-locate-docker-images-for-redocly-and-redoc-cli)
- [Which tag should I use for operations that cannot be logically grouped?](#which-tag-should-i-use-for-operations-that-cannot-be-logically-grouped)
- [Which vendor extensions does Redocly support?](#which-vendor-extensions-does-redocly-support)

## How do I enable the Console API?

Redocly API Reference Docs supports the Console API, though it is disabled by default. You can enable it in 'API Reference Settings'->'Live Configuration'. Redoc Community Edition does not support the Console API.

## Redoc Community Edition is not rendering my large json file smoothly.

Consider upgrading. Redocly API Reference Docs includes an option to section files.

referenceDocs:
layout:
scope: section

If upgrading is not an option, simplifying your schema or reducing file size can both help to improve performance.

## Does Redocly support webhooks with OpenAPI 3.1?

Yes, Redocly supports OpenAPI 3.1 webhooks. See [\#1304](https://github.com/Redocly/redoc/pull/1304) for more information.

## How do I adjust the theme settings on a page, such as color, line spacing, and fonts?

Redoc.ly API Reference Docs supports themes, with a limited subset of theme features supported by Redoc Community Edition. Discover more information on configuring page themes [here](https://redoc.ly/docs/cli/configuration/reference-docs/#theming).

## Where can I locate Docker images for Redocly and redoc cli?

[Redoc Docker Image](https://hub.docker.com/r/redocly/redoc)
[redoc.cli Docker Image](https://hub.docker.com/r/broothie/redoc-cli). See [\#1158](https://github.com/Redocly/redoc/pull/1158) for more information.

## Which tag should I use for operations that cannot be logically grouped?

When `x-tagGroups` is enabled, each tag must have a group or it will not be displayed. For operations that cannot be logically grouped, use the `other` group/tag. By default, Lint your API definition to ensure that each path has a tag using the [operation-tag-defined](https://redoc.ly/docs/cli/built-in-rules/#operation-tag-defined) built-in rule. Note that there is no built-in rule to check that tags aren't missing from the `x-tagGroups` groups definitions.

## Which vendor extensions does Redocly support?

You can view the list of supported vendor extensions [here](https://redoc.ly/docs/api-reference-docs/vendor-extensions/redoc-supported-extensions/).

0 comments on commit fa5f923

Please sign in to comment.