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.

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

Merged
merged 3 commits into from
Sep 1, 2021

Conversation

HCloward
Copy link
Contributor

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

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

@HCloward HCloward changed the title Removes content that is now in documentation and adds link to docs [DOCS]Removes content that is now in documentation and adds link to docs Aug 30, 2021
@HCloward HCloward changed the title [DOCS]Removes content that is now in documentation and adds link to docs [GSOD]Removes content that is now in documentation and adds link to docs Aug 30, 2021
Copy link
Member

@RomanHotsiy RomanHotsiy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great 👏

Copy link
Contributor

@ivana-isadora ivana-isadora left a 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)
Copy link
Contributor

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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Adam Altman <adam@rebilly.com>
@swapnilogale swapnilogale merged commit 1d088a8 into Redocly:master Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants