Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a policy to reject commits that have a hyperlink on the word "here" #1690

Closed
DeflateAwning opened this issue Dec 11, 2023 · 2 comments

Comments

@DeflateAwning
Copy link
Contributor

DeflateAwning commented Dec 11, 2023

Example 1

Bad practice: Click here to go to Google.

Way better: Visit Google to learn more.

Example 2

Bad: Find the service on GitHub here

Good: Find the Disk91 Chipstack service on GitHub

:(

I fixed up most instances of this a while ago, but someone keeps adding them (for an example, click here).

Reasoning

This is an SEO advancement, as well as a speedreading thing. When you're looking for a link, it's way easier to find the link by reading the highlighted text. There's a miriad of other reasons to enforce this rule.

@jthiller
Copy link
Contributor

I strongly agree. I think we could start to hammer out a 'docs style guide'

@jthiller
Copy link
Contributor

jthiller commented Feb 1, 2024

Closing this issue to clean up the overall issues backlog, but continuing to track in #1740 as a priority.

@jthiller jthiller closed this as completed Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants