docs: Add Version Support section to Readme #1337
Conversation
alanbsmith
added
documentation
| [](https://github.com/Workday/canvas-kit/actions/workflows/release.yml) | ||
| <a href="https://github.com/Workday/canvas-kit/actions/workflows/release.yml"> | ||
| <img alt="Release" src="https://github.com/Workday/canvas-kit/actions/workflows/release.yml/badge.svg"> | ||
| </a> |
There was a problem hiding this comment.
I noticed this badge was rendering fine in Storybook but not in our Readme. So I updated it to use HTML instead of MD.
| <a href="./modules/docs/mdx/CONTRIBUTING.mdx"> | ||
| <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome" /> | ||
| </a> | ||
|
|
||
| --- | ||
|
|
||
| **:white_check_mark: For a list of available react modules see | ||
| [Canvas Kit Component Status](./modules/docs/mdx/COMPONENT_STATUS.mdx)** | ||
| _For a list of available react modules see |
There was a problem hiding this comment.
The ✅ wasn't rendering properly in MD, and I wasn't entirely sure if made sense, so I removed it.
|
Test summary
Run details
View run in Cypress Dashboard ➡️ This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard |
| The next major version is typically an unstable environment and has major breaking changes. You are | ||
| welcome to pull this version down for local development and experimentation, but we generally | ||
| recommend against using it in production until the first stable version has been released. | ||
|
|
There was a problem hiding this comment.
is it worth pointing out where this info can be found or where we can see the current version? Example: You can find out current here
Also i know this has come up before but do we host a storybook with a previous version and a current version?
There was a problem hiding this comment.
Good callouts! I'd like to add another section about our repo branches and where to find things.
We don't have a stable URL reference for previous Storybook versions, but you can find the Chromatic artifacts.
I think I would like that information to live in our development docs in a dedicated section and / or an FAQ.
|
No blocking comments, LGTM 👍 |
Summary
Fixes: #1336