Updating Readme.md

[fakela]

1. comparison of features of the community edition vs. premium
2. careers available mentions (link to Redoc.ly/careers)
3. create-openapi-repo tool definition and link
4. Redoc CLI definition and link
5. A table to show the overview of Redocly Product
6. Update Redoc CLI Readme
7. Edits to the Readme documentation where it was needed

[janbrasna]

I've added a couple of notes for staff/owners reviewing this:

[janbrasna]

Not sure about the capitalisation as the project generally uses lowercase for actual packages (as is customary elsewhere) — I'd leave that to staff reviewer eventually.

[fakela]

Well, I suggest there could be some sort of terminology guide that guides contributors on the terms used and their correct format as it wasn't stated earlier.

[janbrasna]

Exactly.

I'm not sure where to start, if that's something to be covered under, dunno, contributing, or coc, or somewhere "officially" in the repo wiki or project boards? But having an official reference for styling and branding would help, as it seems that has evolved in the past somewhat.

[fakela]

Well, I think it can be covered in a part under the docs under contributing guidelines or on GitHub. Something that enables someone reference easily.

[janbrasna]

There's a WIP style guide here: https://github.com/Redocly/redoc/pull/1346/files#diff-cb328360a4c7e8b7b8073808479a3581 so let's see how that unfolds. Nonetheless it's neither complete in terms of addressing the various forms of product naming nor approved by the maintainers, so it's maybe a place to voice some open questions or feedback what to include in such style guide.

[janbrasna]

Again, prolly not the ideal way to capitalize, given the usage elsewhere in lowercase anyways…

[fakela]

This needs to be checked by the staff reviewers on the correct terminologies but i guess we would go with lowercase for consistency in the docs

[janbrasna]

This sounds a bit confused with https://github.com/Redocly/openapi-cli — the redoc-cli is just the interface of the main Redoc, bundling/serving/previewing the output, so I'd rather not describe any "business" features here and keep the link to the repo root itself instead for more explanation (where such maintenance is provided, w/ up to date information).

[fakela]

Well, redoc-cli https://github.com/Redocly/redoc/tree/master/cli and openapi-cli https://github.com/Redocly/openapi-cl are different. The readme for the redoc-cli was sparse so I added more information in it.

[janbrasna]

IMO the ideal way would be to describe the difference that it makes from core redoc js, which is to "bundle your docs into zero-dependency HTML file", i. e. for a self-contained output.

[janbrasna]

… and, yes, it's a live (--watch) preview for any spec changes in real time, and also the way of server-side React pre-rendering, so it's kinda hard to describe just on its own, I agree;)

Maybe that's why the current docs are so sparse, as it serves several use cases for development, production and distribution that are inferred from other parts of the docs (or GH issues for that matter).

[fakela]

I will try to draw a definition from the main documentation, thanks alot for your comments or maybe i can wait for the staff reviewers for their inputs

[ivana-isadora]

Hello! We're cleaning up old docs-related PRs in this repository. As this one was part of trial day work and it hasn't been merged in the meantime, we're going to close it. You're always welcome to contribute to Redoc by opening a fresh pull request. :)