From 5473bd7f3009752ab9fd7a284d0e42b18e9c01eb Mon Sep 17 00:00:00 2001 From: Scott Henderson Date: Thu, 13 Jun 2024 15:51:57 -0700 Subject: [PATCH] better readme --- docs/README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 4a5b928..87876c7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,7 @@ -# This folder contains documentation on configuring a website based on this template +# Recommended Additional Configuration -Some template feature require additional GitHub settings. For example, the `netlifypreview.yaml` workflow requires a [netlify account](https://www.netlify.com) and configuring Netlify and GitHub to work together \ No newline at end of file +Some template features require additional GitHub settings. For example, the [netlifypreview.yaml](.github/workflows/netlifypreview.yaml) workflow requires a [netlify account](https://www.netlify.com) and configuring Netlify and GitHub to work together + +[github-setup.md](./github-setup.md): Our recommendations for configuring a GitHub organization and managing secrets for a Hackweek + +[netlify-setup.md](./github-setup.md): Documentation on setting up previews of website changes in pull requests with Netlify \ No newline at end of file