Docs: remove duplicate code path analysis document #15033
Merged
+2
−550
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
We have two same documents about code path analysis:
(A) https://github.com/eslint/eslint/blob/master/docs/developer-guide/code-path-analysis.md
(B) https://github.com/eslint/eslint/blob/master/docs/developer-guide/code-path-analysis/README.md
Links in other documents are pointing to (A).
This is (A) on our website: https://eslint.org/docs/developer-guide/code-path-analysis
(B) is actually inaccessible on our website (unless someone adds
/index.html
to the URL) due to Netlify's default rules which redirectfoo/bar/
tofoo/bar
if there'sfoo/bar.html
file on the server. https://eslint.org/docs/developer-guide/code-path-analysis/ would be (B) but it redirects to (A).In #14886, we updated only (B). It took me time to figure out why the change doesn't appear on https://eslint.org/docs/8.0.0/developer-guide/code-path-analysis, and then I updated (A) manually on the website (eslint/archive-website#865).
In #14287 we updated both documents with seemingly same changes, but the change in (B) was slightly different and wrong.
Maintaining two documents with the same content is obviously error-prone, so I think we should remove one of them.
What changes did you make? (Give an overview)
Is there anything you'd like reviewers to focus on?
If anyone wants to double-check the final version in (A), I compared (A) and (B) locally and the only differences I could find were:
.svg
files (this is expected)