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

docs: fix redocly cli quickstart #1585

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

techstacksavvy
Copy link

@techstacksavvy techstacksavvy commented Jun 10, 2024

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

  • check the existing instructions still work
  • improve the copy on this page, including something about why each task is useful
  • add some additional common first tasks, such as defining a ruleset or bundling a file

@techstacksavvy techstacksavvy requested a review from a team as a code owner June 10, 2024 21:09
Copy link

changeset-bot bot commented Jun 10, 2024

⚠️ No Changeset found

Latest commit: bbbb643

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@tatomyr tatomyr changed the title Fix/redocly cli quickstart issue1517 docs: fix redocly cli quickstart Jun 11, 2024
@lornajane
Copy link
Collaborator

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 redocly.yaml config file using the minimal ruleset and adding a couple of other built-in rules on top.

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

@lornajane lornajane force-pushed the fix/redocly-cli-quickstart-issue1517 branch from 3596d8a to f9349fa Compare July 19, 2024 10:19
@lornajane lornajane force-pushed the fix/redocly-cli-quickstart-issue1517 branch from f9349fa to 53fb089 Compare July 19, 2024 10:31
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.

Review and update the quickstart guide
2 participants