From 4e82511073dc1b087eee39549bb83d4a5c7472e2 Mon Sep 17 00:00:00 2001 From: Heather Cloward Date: Fri, 30 Jun 2023 16:53:01 -0400 Subject: [PATCH] docs: updates product name from ReDoc to Redoc --- .github/CONTRIBUTING.md | 8 ++++---- docs/redoc-vendor-extensions.md | 2 +- docs/security-definitions-injection.md | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e50e7eb9..ea300447 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,8 +1,8 @@ -# ReDoc Contributing Guide +# Redoc Contributing Guide -Hi! We're really excited that you are interested in contributing to ReDoc. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines. +Hi! We're really excited that you are interested in contributing to Redoc. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines. -- [ReDoc Contributing Guide](#redoc-contributing-guide) +- [Redoc Contributing Guide](#redoc-contributing-guide) - [Issue Reporting Guidelines](#issue-reporting-guidelines) - [Pull Request Guidelines](#pull-request-guidelines) - [Development Setup](#development-setup) @@ -90,7 +90,7 @@ There are some other scripts available in the `scripts` section of the `package. - **`src/common-elements`**: contains common Styled elements or components used in multiple places - **`src/components`**: contains main visual components - - **`src/services`**: contains different services used by ReDoc including MobX stores + - **`src/services`**: contains different services used by Redoc including MobX stores - **`src/services/models`**: contains classes for OpenAPI entities (e.g. Response, Operations, etc) - **`src/types`**: contains extra typescript typings including OpenAPI doc typings - **`src/utils`**: utility functions diff --git a/docs/redoc-vendor-extensions.md b/docs/redoc-vendor-extensions.md index 3232ec36..058405a0 100644 --- a/docs/redoc-vendor-extensions.md +++ b/docs/redoc-vendor-extensions.md @@ -112,7 +112,7 @@ x-tagGroups: ###### How to use with Redoc -Use `x-ignoredHeaderParameters` to specify header parameter names which are ignored by ReDoc. +Use `x-ignoredHeaderParameters` to specify header parameter names which are ignored by Redoc. ###### x-ignoredHeaderParameters example ```yaml diff --git a/docs/security-definitions-injection.md b/docs/security-definitions-injection.md index ad9715e4..ded59881 100644 --- a/docs/security-definitions-injection.md +++ b/docs/security-definitions-injection.md @@ -8,11 +8,11 @@ You can inject the Security Definitions widget anywhere in your specification `d Some description - + ... ``` The inject instruction is wrapped in an HTML comment, -so it is **visible only in ReDoc** and not visible, for instance, in the SwaggerUI. +so it is **visible only in Redoc** and not visible, for instance, in the SwaggerUI. # Default behavior