X Tutup
The Wayback Machine - https://web.archive.org/web/20250513195015/https://github.com/github/docs/issues/16849
Skip to content

Incorrectly rendered apostrophe symbol in the Get Started page. Overall inconsistency. #16849

Closed
@bandantonio

Description

@bandantonio

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/get-started

Overview

Generally, all the pages included into the Get Started, use a single quote symbol ' as an apostrophe:

  1. Example 1
  2. Example 2
  3. Example 3

However, at the bottom of the page, there is the Learning about GitHub with several inconsistencies:

apostrophe

The first article in the list uses an HTML entity to be rendered as a single quote; the second one uses the ’ symbol (Close curly quote) as an apostrophe.

Thoughts

As my testing shown, text in links doesn't get replaced with HTML entities, so the usage of ', ' or other stuff like that is faulty.

A kind of weird thing is that the title in the GitHub's products page does use the single quote symbol:

title: GitHub's products

In contrary, the FAQ about changes to GitHub’s plans does use a faulty symbol:

title: FAQ about changes to GitHub’s plans

So, the issue with the ' does exist.

What part(s) of the article would you like to see updated?

Keep apostrophes consistent: just replace all the weird symbols and HTML entities with the hard-coded ' symbol, as it seems it doesn't break a thing.

Additional information

I would like to create a PR to fix this inconsistency, but I need additional guidance on debugging this issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamengineeringWill involve Docs Engineeringwaiting for reviewIssue/PR is waiting for a writer's review

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      X Tutup