-
Notifications
You must be signed in to change notification settings - Fork 131
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
docs: fix redocly cli quickstart #1585
base: main
Are you sure you want to change the base?
docs: fix redocly cli quickstart #1585
Conversation
|
Thanks @techstacksavvy, this is an improvement already! The first two sections are good, I just removed the part about cloning the starter repo since people probably don't want to do that if they already have an API description to use - it's there in the admonition as an optional resource. For the final section, could you please revisit the example? We already have a rule that requires a summary (https://redocly.com/docs/cli/rules/operation-summary/) so users shouldn't be creating a custom rule for that. A better example might be "craft a custom ruleset" - get the users to add a I would also like to have a "more resources" section at the end of the quickstart to send people to more resources in case they are interested. If you can add this as well, that would be excellent. (I added a commit to your branch so make sure you update before doing more editing, and let us know if you have questions!) |
3596d8a
to
f9349fa
Compare
f9349fa
to
53fb089
Compare
What/Why/How?
Validated existing instructions, refined page copy with explanations of the utility of each task, and added a common initial task
Reference
Resolves #1517
Check yourself