Skip to content

Commit

Permalink
better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
scottyhq committed Jun 13, 2024
1 parent afa5b33 commit 5473bd7
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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
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

0 comments on commit 5473bd7

Please sign in to comment.