Setting baseurl for non-custom domain via github pages

[Ademsk1]

Checklist

• I have read and accepted the contributing guidelines.

Description

Hi there
I just wanted to share something that confused me a little bit in the documentation for getting started. In the deployment section it reads:

Before deploying, check the _config.yml file and ensure the url is configured correctly. If you prefer a project site and don’t use a custom domain, or if you want to visit your website with a base URL on a web server other than GitHub Pages, remember to set the baseurl to your project name, starting with a slash, e.g., /project-name.

I think this reading is a little confusing. It first says "if you prefer a project site (links to github pages) and dont use a custom domain (i personally don't), or you want to use something other than github pages, then set the base url to your project name"

Logically, I then read this as : If you are using github pages and have a custom domain, then don't use the baseurl. Otherwise, set it as your project name i.e. baseurl: /project-name

I tried doing this, and I get an error in the test deployment

* At _site/tags/index.html:1:
  internal script reference /ademsk1.github.io/app.min.js?baseurl=/ademsk1.github.io&register=true does not exist

Then I set baseurl to be just an empty string, and it's worked fine.

Any thoughts on this? Does this require a change in the getting started section?

EDIT

After rereading the Github pages, I think I understand what's happening. Because I've set my repo name to be the same name as the domain name github gives, I don't need to adjust my baseurl. However, if I were to use say blog then that would be reflected as https://<username>.github.io/blog.

Have I got that right?

[cotes2020]

Have I got that right?

Yes, you've got that right!