-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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.
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
[GSOD]Removes content that is now in documentation and adds link to docs #1737
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great 👏
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! 👏 I only have a couple of small suggestions.
- [Server-side rendering (SSR) ready](https://redoc.ly/docs/redoc/quickstart/cli/#redoc-cli-commands) | ||
- [Simple integration with `create-react-app`](https://redoc.ly/docs/redoc/quickstart/react/) | ||
|
||
[See an example](https://github.com/APIs-guru/create-react-app-redoc) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we specify what this is an example of? It looks like it's related to the previous bullet point about the React app, so maybe just combine them somehow.
Co-authored-by: Adam Altman <adam@rebilly.com>
What/Why/How?
Since my updates to the Redoc documentation have been published, I thought it would be a good idea to start updating the README file. One of the main ways I updated it was by removing the content that is now documented and including a link instead. I also did some other minor cleanup. I plan to do more work on the README in another PR.
Reference
I have a task on my GitHub project board. https://github.com/HCloward/redoc/projects/1#card-67733561
Testing
n/a
Screenshots (optional)
n/a
Check yourself
n/a