Update README for vercel.com/templates #1442
Conversation
|
|
@malewis5 is attempting to deploy a commit to the BigCommerce Platform Team on Vercel. A member of the Team first needs to authorize it. |
|
Please do not merge. |
malewis5
changed the title
|
Ready to merge. |
malewis5
changed the title
There was a problem hiding this comment.
Still looks good to me but I am going to differ to @matthewvolk for approval/merge.
| > [!IMPORTANT] | ||
| > If you just want to build a storefront, start with the [CLI](#quickstart) which will install the Next.js application in [/core](/core/). | ||
| > **Important:** | ||
| > If you just want to build a storefront, start with the [CLI](#quickstart) which will install the Next.js application in [/core](https://github.com/bigcommerce/catalyst/tree/main/core). |
There was a problem hiding this comment.
@matthewvolk shouldn't this be the root monorepo now instead of /core?
There was a problem hiding this comment.
Correct! Let's maybe change it to:
| > If you just want to build a storefront, start with the [CLI](#quickstart) which will install the Next.js application in [/core](https://github.com/bigcommerce/catalyst/tree/main/core). | |
| > If you just want to build a storefront, start with the [CLI](#quickstart) which will install the [entire Catalyst repository](https://github.com/bigcommerce/catalyst) locally. |
When published to Vercel templates the README is used for the description. I updated some links and syntax so the description will show up correctly.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
|
Not sure where we are at here, but wanted to check in. @malewis5 and @matthewvolk do we need anything to move this forward? |
What/Why?
When published on the Vercel templates page we use the README for the template description. It doesn't support Github markdown language so the "Important" highlighting needed to be changed. We also don't support relative links so all links have absolute paths.
Testing
With these new changes the description on vercel.com/templates should look correct and the Deploy button on the README should successfully deploy a project to Vercel.