Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-08-04 04:10:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: updates product name from ReDoc to Redoc

Browse Source
This commit is contained in:
Heather Cloward 2023-06-30 16:53:01 -04:00
parent 79acc21eed
commit 4e82511073
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.github/CONTRIBUTING.md vendored
View File

@ -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

2
docs/redoc-vendor-extensions.md
View File

@ -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

4
docs/security-definitions-injection.md
View File

@ -8,11 +8,11 @@ You can inject the Security Definitions widget anywhere in your specification `d
Some description
<!-- ReDoc-Inject: <security-definitions> -->
<!-- Redoc-Inject: <security-definitions> -->
...
```
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