APPS: 7288: Update README for ZCLI GA release#324
APPS: 7288: Update README for ZCLI GA release#324zendesk-poonam wants to merge 2 commits intomasterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repository’s top-level documentation to reflect ZCLI’s general availability status and to position ZCLI as the supported successor to Zendesk App Tools (ZAT).
Changes:
- Replaces “beta” messaging with “generally available” wording in the README intro.
- Adds a prominent note stating ZCLI succeeds ZAT and recommends migrating.
- Removes the prior “beta” contributing caveat about limited issue/PR review.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Contributing | ||
|
|
||
| --- | ||
|
|
||
| **Note:** While ZCLI is in beta, we are not routinely reviewing issues and merging community-submitted pull requests. We hope to begin reviewing these again soon, but for the moment we appreciate your patience. | ||
|
|
||
| --- | ||
|
|
||
| Thanks for your interest in ZCLI! Community involvement helps improve the experience for all developers using the Zendesk platform. | ||
|
|
||
| Got issues with what you find here? You can [create an issue on Github](https://github.com/zendesk/zcli/issues/new), report the issue in the [Zendesk Developers Slack group](https://docs.google.com/forms/d/e/1FAIpQLScm_rDLWwzWnq6PpYWFOR_PwMaSBcaFft-1pYornQtBGAaiJA/viewform), or for other problems, [contact Zendesk Customer Support](https://support.zendesk.com/hc/en-us/articles/360026614173). |
There was a problem hiding this comment.
The link text uses the nonstandard casing "Github". Please change it to "GitHub" for correct branding and consistency.
zendesk-poonam
force-pushed
the
poonam/APPS-7288-Update-public-docs-for-ZCLI-GA
branch
from
fdae2bd to
8a5f6df
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ZCLI is a Zendesk CLI which helps you build and manage your Zendesk apps and themes from the command line. ZCLI is currently available in beta and is built using the [oclif](https://github.com/oclif/oclif) framework. | ||
| ZCLI is a Zendesk CLI which helps you build and manage your Zendesk apps and themes from the command line. ZCLI is built using the [oclif](https://github.com/oclif/oclif) framework. | ||
|
|
||
| > **Note:** ZCLI is the successor to Zendesk App Tools (ZAT). If you're currently using ZAT, please migrate to ZCLI for the latest features and support. |
There was a problem hiding this comment.
The new note is formatted as a blockquote (> **Note:** ...), but the README’s other note uses plain bold text. To keep the document consistent (and avoid odd rendering differences), consider using the same note style for both sections (either both blockquoted or both plain).
| > **Note:** ZCLI is the successor to Zendesk App Tools (ZAT). If you're currently using ZAT, please migrate to ZCLI for the latest features and support. | |
| **Note:** ZCLI is the successor to Zendesk App Tools (ZAT). If you're currently using ZAT, please migrate to ZCLI for the latest features and support. |
zendesk-poonam
force-pushed
the
poonam/APPS-7288-Update-public-docs-for-ZCLI-GA
branch
from
8a5f6df to
60da865
Compare
Description
b63bdd5Update README to announce ZCLI general availability60da865docs: refresh README according to commentDetail
Update README to announce ZCLI General Availability by removing beta references and adding a note that ZCLI is the successor to ZAT.
JIRA: https://zendesk.atlassian.net/browse/APPS-7288
Checklist