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

Config docs and README refresh #2393

Merged
merged 10 commits into from
Sep 21, 2023
Merged

Config docs and README refresh #2393

merged 10 commits into from
Sep 21, 2023

Conversation

lornajane
Copy link
Contributor

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

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

@lornajane lornajane requested review from a team as code owners August 23, 2023 10:50
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
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
README.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
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.

It looks great!

I left a few comments.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@HCloward HCloward left a comment

Choose a reason for hiding this comment

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

These updates look great!

lornajane and others added 2 commits September 18, 2023 14:47
…ing method and improve docs/examples on that page
@lornajane
Copy link
Contributor Author

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

@AlexVarchuk
Copy link
Collaborator

@lornajane It looks good to me! Thank you! 🙌

@lornajane lornajane merged commit b3503f2 into main Sep 21, 2023
6 checks passed
@lornajane lornajane deleted the redoc-config-and-landing branch September 21, 2023 14:19

- [npm](https://docs.npmjs.com/about-npm)
- [yarn](https://classic.yarnpkg.com/en/docs/getting-started)
:::Success URL or local file
Copy link
Member

Choose a reason for hiding this comment

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

Needs a lowercase s in success.


### More usage options

Check out the [deployment documentation](./deploment/index/md) for more options, and detailed documentation for each.
Copy link
Member

Choose a reason for hiding this comment

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

This link looks wrong.

@lornajane
Copy link
Contributor Author

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants