Empty github pages: Improve documentation on use_pkgdown_github_pages()

[valentingar]

Problem: Running use_pkgdown_github_pages() in a different branch than root leads to correct github workflow which however create an empty site and leads to a 404 error message when accessing the site.

Solution: The documentation in use_pkgdown_github_pages() should inform the user that the changes need to be pushed to the main branch of the repository.

How to reproduce Run use_pkgdown_github_pages() in a branch other than the root branch for a package where pkdown is not yet configured.

Usethis is great because it enables users without deep understanding of the underlying processes - like me - to do really useful things. In order to test out pkdown deployment, I first wanted to do so in a different branch to prevent any hiccups. Of course this lead to a missing _pkgdown.yml in the main branch so that the github workflow created an empty site. Because the process did not produce an error message and the github workflow ran successful, it wasnt immediately obvious what the problem was to me. Pushing the changes to the main branch fixed the problem.

Thanks a lot for your great work!!

[jennybc]

Sounds like use_pkgdown() (probably? it gets called very early in use_pkgdown_github_pages()) should gain some sort of "Are you sure you want to do this in a branch that is not main?" type of challenge.

Similar to something we do already in some of the pr_*() functions, e.g.:

usethis/R/pr.R

Lines 199 to 203 in 20e7eb2

	default_branch <- if (online) git_default_branch_(cfg) else guess_local_default_branch()
	challenge_non_default_branch(
	"Are you sure you want to create a PR branch based on a non-default branch?",
	default_branch = default_branch
	)

In the pkgdown case, the point is that site build and deploy machinery won't start to truly function until all the relevant changes are in the default branch.