Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Remove references to interactive docs in the open source project #2460

Merged
merged 2 commits into from
Dec 1, 2023
Merged

docs: Remove references to interactive docs in the open source project #2460

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fcd2df4
docs: Remove references to interactive docs in the open source project
lornajane Nov 30, 2023
4518d93
Update README.md
lornajane Dec 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div align="center">
<img alt="Redoc logo" src="https://raw.githubusercontent.com/Redocly/redoc/main//docs/images/redoc.png" width="400px" />

# Generate interactive API documentation from OpenAPI definitions
# Generate beautiful API documentation from OpenAPI definitions
lornajane marked this conversation as resolved.
Show resolved Hide resolved

[![npm](http://img.shields.io/npm/v/redoc.svg)](https://www.npmjs.com/package/redoc) [![License](https://img.shields.io/npm/l/redoc.svg)](https://github.com/Redocly/redoc/blob/main/LICENSE)

Expand Down Expand Up @@ -34,8 +34,6 @@ enter the URL for your definition and select **TRY IT**.

- Responsive three-panel design with menu/scrolling synchronization
- Support for OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0
- [Multiple deployment options](https://redocly.com/docs/redoc/)
lornajane marked this conversation as resolved.
Show resolved Hide resolved
- Interactive interface so your users can try the API immediately
- Ability to integrate your API introduction into the side menu
- High-level grouping in side menu with the [`x-tagGroups`](https://redocly.com/docs/api-reference-docs/specification-extensions/x-tag-groups/) specification extension
- [Simple integration with `create-react-app`](https://redocly.com/docs/redoc/quickstart/react/)
Expand Down Expand Up @@ -75,7 +73,7 @@ Add your own `spec-url` to the `<redoc>` tag; this attribute can also be a local

Check out the [deployment documentation](./docs/deployment/intro.md) for more options, and detailed documentation for each.

## Redoc vs. Reference
## Redoc vs. Redocly API Reference
lornajane marked this conversation as resolved.
Show resolved Hide resolved

Redoc is Redocly's community-edition product. Looking for something more?
We also offer [hosted API reference documentation](https://redocly.com/docs/api-registry/guides/api-registry-quickstart/)
Expand Down
Loading