Docs: Fix broken links in Nodejs-api docs #13415
Conversation
|
|
eslint-deprecated
bot
added
the
triage
kaicataldo
added
accepted
docs/developer-guide/nodejs-api.md
Outdated
| * [constructor()][eslint-constructor] | ||
| * [lintFiles()][eslint-lintFiles] | ||
| * [lintText()][eslint-lintText] | ||
| * [calculateConfigForFile()][eslint-calculateConfigForFile] | ||
| * [isPathIgnored()][eslint-isPathIgnored] | ||
| * [loadFormatter()][eslint-loadFormatter] | ||
| * [static version][eslint-version] | ||
| * [static outputFixes()][eslint-outputFixes] | ||
| * [static getErrorResults()][eslint-getErrorResults] | ||
| * [LintResult type](lintresult) | ||
| * [LintMessage type](lintmessage) | ||
| * [EditInfo type](editinfo) | ||
| * [Formatter type](formatter) |
There was a problem hiding this comment.
There are definitions of [eslint-constructor]-like links at the end of this file. Would you fix those instead? Those links are used in other places as well.
|
Hmm. The page in GitHub (/docs/developer-guide/nodejs-api.md) works fine. The root cause is, our website and GitHub markdown create different IDs for the markdown headers. I wonder if we can fix our website's ID generator or not. |
|
Updated table of contents to use new links at file end. It still has the problem you mentioned about Github docs and website docs having different header IDs. (can jump on website, but not on Github md) |
|
We use AnchorJS to create these links, if someone wants to see if we can get the behavior to match how GitHub generates these links. |
kaicataldo
dismissed
their stale review
We should fix the link generation of the site instead of breaking the Markdown docs.
|
We could override AnchorJS's urlify, though I'm not sure if it's part of its public API. Or, generate header ids upfront, which is supported by AnchorJS:
Or, maybe use a different library that supports custom functions that create ids, instead of AnchorJS. As for the function, there's github-slugger. Though, I'm not sure if it matches what github is doing with that |
| * [LintResult type][lintresult] | ||
| * [LintMessage type][lintmessage] | ||
| * [EditInfo type][editinfo] | ||
| * [Formatter type][formatter] |
There was a problem hiding this comment.
👍
this was broken in markdown
|
It seems that the main problem should be fixed in the eslint/website repo, but I think we should merge this PR first, because it converts uppercase links to lowercase, which is consistent with other documents and most likely something we'll rely on. GitHub seems to have a script that handles any case, but we don't have that on the website. For example: https://github.com/eslint/eslint/blob/master/docs/user-guide/configuring.md#Specifying-Processor (works) https://eslint.org/docs/user-guide/configuring#Specifying-Processor (doesn't work) Also, this PR fixes links that were broken for another reason ( |
| ### ◆ new ESLint(options) | ||
| ### new ESLint(options) |
There was a problem hiding this comment.
I'm not sure if we want to remove ◆
(though, removing these will probably lead to less possible problems later on the website)
Thoughts from the team?
| [eslint-constructor]: #new-eslint-options | ||
| [eslint-lintfiles]: #eslint-lintfiles-patterns | ||
| [eslint-linttext]: #eslint-linttext-code-options | ||
| [eslint-calculateconfigforfile]: #eslint-calculateconfigforfile-filepath | ||
| [eslint-ispathignored]: #eslint-ispathignored-filepath | ||
| [eslint-loadformatter]: #eslint-loadformatter-nameorpath | ||
| [eslint-version]: #eslint-version | ||
| [eslint-outputfixes]: #eslint-outputfixes-results | ||
| [eslint-geterrorresults]: #eslint-geterrorresults-results |
There was a problem hiding this comment.
These should be reverted to work well on GitHub (we should just convert uppercase to lowercase).
|
The broken links have been fixed, so closing. |
eslint-github-bot
bot
added
the
archived due to age
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
nodejs-api.md. Should fix broken links in the ESLint website docsIs there anything you'd like reviewers to focus on?