Config docs and README refresh #2393
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
HCloward
reviewed
Sep 1, 2023
RomanHotsiy
reviewed
Sep 3, 2023
Co-authored-by: Heather Cloward <[email protected]>
HCloward
reviewed
Sep 5, 2023
HCloward
reviewed
Sep 5, 2023
HCloward
reviewed
Sep 5, 2023
HCloward
approved these changes
Sep 5, 2023
…ing method and improve docs/examples on that page
Co-authored-by: Heather Cloward <[email protected]>
|
@AlexVarchuk could you please check over these changes? I've completely rewritten the HTML deployment page, removed the old quickstart and directed people to the HTML page as our easiest onboarding. If you are happy that everything looks accurate, then I think we are probably good to go. Thank you! |
|
@lornajane It looks good to me! Thank you! 🙌 |
AlexVarchuk
approved these changes
Sep 19, 2023
adamaltman
reviewed
Sep 26, 2023
|
|
||
| - [npm](https://docs.npmjs.com/about-npm) | ||
| - [yarn](https://classic.yarnpkg.com/en/docs/getting-started) | ||
| :::Success URL or local file |
There was a problem hiding this comment.
Needs a lowercase s in success.
adamaltman
reviewed
Sep 26, 2023
|
|
||
| ### More usage options | ||
|
|
||
| Check out the [deployment documentation](./deploment/index/md) for more options, and detailed documentation for each. |
|
Thanks! and Yep! Without preview tooling, we missed things when I was writing and in review. I fixed at least one of these on the related sidebars PR on the marketing website. |
ckoegel
pushed a commit
to Bandwidth/redoc
that referenced
this pull request
Nov 1, 2023
* docs: Give Redoc a landing page with overview and tldr instructions * docs: move config to dedicated page * docs: modernise README, link to resources * docs: more detailed format for theme configurations * fix: README formatting * fix: Fix future tense errors and add exceptions for config fields as headings * Apply suggestions from code review Co-authored-by: Heather Cloward <[email protected]> * docs: minor updates from excellent pull request feedback * docs: Remove the old quickstart, update HTML as the preferred onboarding method and improve docs/examples on that page * Apply suggestions from code review Co-authored-by: Heather Cloward <[email protected]> --------- Co-authored-by: Heather Cloward <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What/Why/How?
Configuring Redoc can be confusing, partly because we use our central configuration docs, with some-but-not-all options supported in Redoc. Also the README on this project is epic. This pull request slims down the README, creates a dedicated page for configuration options, and also a docs landing page in case anyone finds the project that way on our main docs.
Check yourself