redocly-cli icon indicating copy to clipboard operation
redocly-cli copied to clipboard

Published 20 hours ago • verified publisher icon Redocly

docs: update commands documentation (issue 1429) and minor corrections

Open dianacheung opened this issue 1 year ago • 10 comments

What/Why/How?

Updated commands documentation per issue 1429 and also made minor changes for correction and consistency.

Reference

https://github.com/Redocly/redocly-cli/issues/1429

Testing

Ran redocly preview for local development. Ran spelling check. Ran vale. Ran mlc. Ran markdownlint.

dianacheung avatar May 13 '24 07:05 dianacheung

⚠️ No Changeset found

Latest commit: 4e9bf470ca7d99c159f2598ee79e8a050bb0e18b

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

changeset-bot[bot] avatar May 13 '24 07:05 changeset-bot[bot]

Ran prettier on the commands md files.

dianacheung avatar May 13 '24 08:05 dianacheung

Hi @lornajane, docs PR still awaiting review and approval from Redocly/technical-writers. Thanks in advance.

dianacheung avatar May 19 '24 20:05 dianacheung

Thanks @dianacheung ! I see it and it's on my list, we will review when we can.

lornajane avatar May 20 '24 08:05 lornajane

Hi @HCloward and @lornajane, thanks for reviewing and providing feedback. I'm out of office for rest of May and plan to pick this PR back up around mid June. I will reach out with any follow up questions on the feedback. Appreciate your patience.

dianacheung avatar May 22 '24 21:05 dianacheung

Hi @lornajane, I'm back to work on the PR suggestions. I have resolved the lint.md conflict on this branch locally. After I make all the necessary updates locally, should I push as a new commit or squash the commits on feature branch? Thanks for any clarifications.

dianacheung avatar Jun 17 '24 04:06 dianacheung

A new commit please

lornajane avatar Jun 17 '24 07:06 lornajane

Hi @lornajane, I pushed my local changes as a new commit to my feature branch issue-1429. The mlc test is failing for installation.md, which is a file I didn't touch. How can I rerun the checks? Please advise. Thanks in advance.

dianacheung avatar Jun 22 '24 00:06 dianacheung

@dianacheung don't worry about the broken link, I'll take a look at that separately

lornajane avatar Jun 26 '24 16:06 lornajane

Hi @lornajane, PR https://github.com/Redocly/redocly-cli/pull/1560 is ready for your approval and merging back to the main branch. I have included the above suggestions from @HCloward and modified the commands documentation per issue https://github.com/Redocly/redocly-cli/issues/1429. I have successfully ran all documentation tests (vale, mlc, markdownlint, prettier). It would be great to close this PR as soon as possible. Thanks in advance.

dianacheung avatar Jun 28 '24 04:06 dianacheung