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

docs: add hash to "tag" config link #5519

Merged
merged 4 commits into from
Sep 21, 2022
Merged

Conversation

mrienstra
Copy link
Contributor

Minor change.

using-npm/config is a long page -- heck, the subtitle is "More than you probably want to know about npm configuration" -- so instead of dumping people at the top of it when they follow the link to learn about the "tag" config, let's send 'em right to the relevant bit.

Aside from it being a long page, one more motivation: trying to get to the section by searching is also slow, it's the 16th (of 24) occurrence of "tag" on the page. (though to be fair, only the 4th if they catch it in the table of contents)

References

Minor change.

[using-npm/config](https://docs.npmjs.com/cli/v8/using-npm/config) is a long page -- heck, the subtitle is "More than you probably want to know about npm configuration" -- so instead of dumping people at the top of it when they follow the link to learn about the "tag" config, let's send 'em right to the relevant bit.

Aside from it being a long page, one more motivation: trying to get to the section by searching is also slow, it's the 16th (of 24) occurrence of "tag" on the page. (though to be fair, only the 4th if they catch it in the table of contents)
@mrienstra mrienstra requested a review from a team as a code owner September 15, 2022 19:42
Copy link
Member

@wraithgar wraithgar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really helpful change.

We do this in other places such as on package-spec when we link into the registry config specifically. Probably lots more places we could do this too.

@mrienstra
Copy link
Contributor Author

@wraithgar, your "lots more places we could do this too" comment inspired me to dig around a little, I added a few more changes to this PR -- almost added a bunch more, but I'll open another PR for the rest so this one doesn't get out of hand.

I used this search:
(?<!^\* \[config\])\(/using-npm/config\)

I ran across a non-standard "See also" footer, I used this search to make sure there weren't any others (nope):
### See also\n\n[^\*]

@mrienstra mrienstra requested a review from wraithgar September 15, 2022 21:54
@mrienstra mrienstra changed the title docs: add hash to "tag" config link docs: add hash to "tag" config link; misc. minor fixes Sep 15, 2022
@lukekarrys lukekarrys changed the title docs: add hash to "tag" config link; misc. minor fixes docs: add hash to "tag" config link Sep 21, 2022
@lukekarrys lukekarrys merged commit 8743366 into npm:latest Sep 21, 2022
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

Successfully merging this pull request may close these issues.

3 participants