Skip to content

Pages > Quickstart > Changing the title and description: Steps regarding _config.yml are misleading #44410

Closed

Description

@ctdiab

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:

  1. The user is instructed on how to create the _config.yml file in a preceding section.
  2. 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

Activity

  1. added
    contentThis issue or pull request belongs to the Docs Content team
    on May 22, 2026
  2. added
    triageDo not begin working on this issue until triaged by the team
    on May 22, 2026
  3. added
    pagesContent related to GitHub Pages
    and removed
    triageDo not begin working on this issue until triaged by the team
    on May 22, 2026
  4. Sharra-writes commented on May 22, 2026

    @Sharra-writes
    Contributor

    @ctdiab Checking in with the team about whether this is functioning as it should, and then (provided it is) we can figure out how/where to add to the instructions.

  5. Addagudi-Sathvik commented on May 29, 2026

    @Addagudi-Sathvik

    Hello @Sharra-writes! I would love to work on this issue. I see you are checking with the team on the intended functionality first. Please let me know once the approach is decided, and I would be happy to be assigned and submit a PR to update the _config.yml instructions.

  6. healthearthack commented on Jun 1, 2026

    @healthearthack

    Just a thought, could also approach where there is an option in the process to select "yes" create the _config.yml whereas default would not create.

  7. Sharra-writes commented on Jun 10, 2026

    @Sharra-writes
    Contributor

    @ctdiab Sorry, this got lost in my pile when I got sick. The Pages team agrees that this should be updated. Creating the _config.yml file can probably be the first step under the "Changing title and description" section, since it's kind of the first step in changing the title and description.

    I'll put a help wanted tag, and whoever wants to can update it. It will be first-come, first-evaluated, @Addagudi-Sathvik, but if I get more than one PR, I'll accept whichever needs the least editing.

    @healthearthack Feature requests are best posted in the community discussions.

  8. added
    help wantedAnyone is welcome to open a pull request to fix this issue
    on Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamhelp wantedAnyone is welcome to open a pull request to fix this issuepagesContent related to GitHub Pages

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions