Github pages deployment docs separate repository step could improve

[keevan]

Preliminary Checks

• This issue is not a duplicate. Before opening a new issue, please search existing issues: https://github.com/gatsbyjs/gatsby/issues
• This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/gatsbyjs/gatsby/discussions

Summary

I went ahead and followed this as I wanted the source code to live in a different repository.

Thinking all was well, I ran the deploy command, but it actually overwrote the contents of my main branch in my current repository. Further exploration revealed additional options available from the gh-pages command.

• Have a separate repository for your source code (so username.github.io is used only for deployment and not really for tracking your source code)

In particular, if this step was followed, it wouldn't work out as expected even if following these instructions directly.

Steps to Resolve this Issue

I plan to push a small PR change for this:

• Have a separate repository for your source code (so username.github.io is used only for deployment and not really for tracking your source code). If going down this route, you will need to add extra option for --repo <repo> (works for https and git urls) in the gh-pages command below.