PDE-4193 doc(cli): doc rebuild and minor updates #688
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
eliangcs
commented
Aug 4, 2023
•
eliangcs
commented
- Port back the doc change docs(cli): Move up template explanation in README #682 from README.md to README-source.md.
- Update the links to the docs of old versions.
- Fix a sentence so it's more natural-sounding using ChatGPT.
szchenghuang
reviewed
Aug 4, 2023
packages/cli/docs/index.html
Outdated
| @@ -414,14 +414,14 @@ <h1 align="center"> | |||
| <div class="col-md-5 col-sm-12 col-height docs-primary"> | |||
| <p align="center"> | |||
| <a href="https://www.npmjs.com/package/zapier-platform-cli"><img src="https://img.shields.io/npm/v/zapier-platform-cli.svg" alt="npm version"></a> | |||
| </p><p>Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform.</p><p>You may find docs duplicate or outdated across the Zapier site. The most up-to-date contents are always available on GitHub:</p><ul> | |||
| </p><p>Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform.</p><p>You may find some documents on the Zapier site to be duplicates or outdated. The most up-to-date contents are always available on GitHub:</p><ul> | |||
There was a problem hiding this comment.
Suggested change
| </p><p>Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform.</p><p>You may find some documents on the Zapier site to be duplicates or outdated. The most up-to-date contents are always available on GitHub:</p><ul> | |
| </p><p>Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform.</p><p>You may find some documents duplicate or outdated on the Zapier site. The most up-to-date contents are always available on GitHub:</p><ul> |
szchenghuang
reviewed
Aug 4, 2023
packages/cli/README.md
Outdated
| @@ -14,7 +14,7 @@ | |||
|
|
|||
| Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform. | |||
|
|
|||
| You may find docs duplicate or outdated across the Zapier site. The most up-to-date contents are always available on GitHub: | |||
| You may find some documents on the Zapier site to be duplicates or outdated. The most up-to-date contents are always available on GitHub: | |||
There was a problem hiding this comment.
Same suggestion here.
szchenghuang
reviewed
Aug 4, 2023
packages/cli/README-source.md
Outdated
| @@ -12,7 +12,7 @@ | |||
|
|
|||
| Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform. | |||
|
|
|||
| You may find docs duplicate or outdated across the Zapier site. The most up-to-date contents are always available on GitHub: | |||
| You may find some documents on the Zapier site to be duplicates or outdated. The most up-to-date contents are always available on GitHub: | |||
szchenghuang
reviewed
Aug 4, 2023
docs/index.html
Outdated
| @@ -414,14 +414,14 @@ <h1 align="center"> | |||
| <div class="col-md-5 col-sm-12 col-height docs-primary"> | |||
| <p align="center"> | |||
| <a href="https://www.npmjs.com/package/zapier-platform-cli"><img src="https://img.shields.io/npm/v/zapier-platform-cli.svg" alt="npm version"></a> | |||
| </p><p>Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform.</p><p>You may find docs duplicate or outdated across the Zapier site. The most up-to-date contents are always available on GitHub:</p><ul> | |||
| </p><p>Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform.</p><p>You may find some documents on the Zapier site to be duplicates or outdated. The most up-to-date contents are always available on GitHub:</p><ul> | |||
szchenghuang
previously approved these changes
Aug 4, 2023
szchenghuang
approved these changes
Aug 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.