Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eeholmes authored Dec 5, 2023
1 parent 602e61a commit af330f3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Having trouble? Scroll down to the troubleshooting section.

The most common trouble users run into is that the book is not rendering. Check the following:

* The `gh-pages` branch exists. If you forgot to check the check box to include all the branches when you created the repo from the template then it won't exist.
* The `gh-pages` branch does not exist. If you forgot to check the check box to include all the branches when you created the repo from the template then it won't exist. The Action will fail if the gh-pages branch does not already exist. You can create the branch and then push a change to main to trigger the Action to run again.
* The GitHub Pages has not been set. You need to go to Pages under settings, and set Pages to build from the `gh-pages` branch.
* You did not allow GitHub Actions to run and/or did not give read/write permission. Go to Settings > Actions > General, and make sure Actions are allowed (top section) and they have read/write permission (bottom section).
* You did not push a change to the main branch. The Action is triggered by a push to main, so try making an edit to README.md and pushing that change.
Expand Down

0 comments on commit af330f3

Please sign in to comment.