diff --git a/docs/examples.md b/docs/examples.md index 6e781c15..100e241b 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -21,6 +21,11 @@ This page links to examples of how to implement some things with the Epic Stack. ## How to contribute +[![Kent screencast showing the examples page](https://github.com/epicweb-dev/epic-stack/assets/1500684/7074f1db-c918-42c6-a724-0b082168395f)](https://www.epicweb.dev/tips/contribute-an-epic-stack-example) + +Watch: +[Contribute an Epic Stack Example](https://www.epicweb.dev/tips/contribute-an-epic-stack-example) + You don't need permission to contribute an example. Feel free to create your own repository based on the Epic Stack and add whatever you like for your example. Here are some tips: @@ -30,6 +35,11 @@ Here are some tips: and see what you've added. 2. Update the `README.md` with some information about what your example is about and call out any interesting things you've done. +3. Add the tags "epic-stack" and "epic-stack-example" so it will appear on + [this page on GitHub](https://github.com/topics/epic-stack-example). +4. It's not normally necessary to deploy your example to production (simply + comment out the deployment part of the GitHub workflow), but you can if you + like. Once you've made your repo, simply open a pull request to this page and add your example to the bottom of the list with a brief description.