Code of Conduct
What article on docs.github.com is affected?
The article in question is the GitHub Pages Quickstart Guide.
What part(s) of the article would you like to see updated?
The part of the article to update is the section Changing the title and description.
I believe that the steps as written are misleading because they imply that the _config.yml file is created automatically once you create a GitHub page. However, this was not the case for me when I created a page, and I found at least one other user on Stack Overflow who was similarly flummoxed.
I would suggest one of 2 options:
- The user is instructed on how to create the
_config.yml file in a preceding section.
- The Changing the title and description section is rewritten to have the user create the
_config.yml file as it appears in the example. This was how I personally solved the issue when trying to follow the Quickstart guide.
Additional information
No response
Code of Conduct
What article on docs.github.com is affected?
The article in question is the GitHub Pages Quickstart Guide.
What part(s) of the article would you like to see updated?
The part of the article to update is the section Changing the title and description.
I believe that the steps as written are misleading because they imply that the
_config.ymlfile is created automatically once you create a GitHub page. However, this was not the case for me when I created a page, and I found at least one other user on Stack Overflow who was similarly flummoxed.I would suggest one of 2 options:
_config.ymlfile in a preceding section._config.ymlfile as it appears in the example. This was how I personally solved the issue when trying to follow the Quickstart guide.Additional information
No response