Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
Description
Before You File a Documentation Request Please Confirm You Have Done The Following...
- I have looked for existingopen or closed documentation requests that match my proposal.
- I haveread the FAQ and my problem is not listed.
Suggested Changes
Spiritual successor to#5242, and following up onhttps://github.com/typescript-eslint/typescript-eslint/pull/5762/files#r994711306: there's still a lot of information stored in.md
files checked into the repo. But we've been directing users to the website -- which makes a divide between two areas of docs.
I propose we make the website the primary andmostly only place to view documentation, including type descriptions such asparserOptions
. That would include guides for contributing and release strategies.
For that many users would expect to be in the repo, I propose we leave them where they are and configure Docusaurus to surface them -- as we've done for rule docs in#5249. The files to leave in-place are:
./.github/*.md
./*.md
./packages/*/README.md
Thoughts?
Affected URL(s)
Potentially many!