sourcegraph / handbook

📘 The Sourcegraph handbook
https://handbook.sourcegraph.com
Apache License 2.0
146 stars 111 forks source link

Slashes in headings removed instead of converted into hyphens in anchors #231

Open quinnkeast opened 2 years ago

quinnkeast commented 2 years ago

Slashes / are removed rather than converted into - in anchors.

For example, on pages like the Teammates page, the she/her is converted into sheher instead of the previous she-her, which breaks existing links to team members using this format.

felixfbecker commented 2 years ago

I think we should change the links instead of changing the ID generation, since the new plugin we use follows the exact algorithm GitHub uses for markdown heading IDs.

Aside: I wonder if it would be easier to have pronouns in the info below the heading instead of in the heading itself. Many times I've wanted to link to a teammate and had to look up the page and copy-paste the link because it's hard to remember how the IDs are generated in this case. If it was just names, it would be easy to write by hand in most cases.

quinnkeast commented 2 years ago

Makes sense to me! How about we just change the links to start with, and then look at the rest of it later?

felixfbecker commented 2 years ago

Yeah, would probably just be a quick search+replace with an IDE.

marybelzer commented 2 years ago

@felixfbecker @quinnkeast Now that the team page is generated from a yaml file, is this still an issue?