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: link mentions of config parameters #5521

Merged
merged 2 commits into from
Sep 21, 2022
Merged

Conversation

mrienstra
Copy link
Contributor

Inspired by #5519 (review), went looking for config parameter references in docs that could use a hash in their link, ended up finding unlinked references instead. This PR links them to /using-npm/config.

I tried to be thoughtful about which ones I linked and which I skipped. For example, in docs/content/using-npm/logging.md, I didn't link logs-dir or loglevel because the information in /using-npm/config didn't add anything new.

I think I avoided making any edits inside "automatically generated" sections.

I initially used this search:
(?<!`workspace)` config[^\]]
... including *.md files, and excluding CHANGELOG.md,CHANGELOG-*.md files.

I started out excluding `workspace` config because it occurs often in automatically generated sections.

I later went back and checked all occurrences of `workspace` config, I found one that seemed worth linking.

I searched for:
^.{81}
(including *.md files, and excluding CHANGELOG.md,CHANGELOG-*.md files)
... to make sure I respected what seem to be the norm (lines wrapped at 80 chars). Seems like there are lots of exceptions, should those be fixed, and should that norm be documented somewhere?

References

Continuation of #5519

@mrienstra mrienstra requested a review from a team as a code owner September 15, 2022 22:56
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