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: Consider surfacing remaining docs from repo Markdown files on the website #5824

Closed
2 tasks done
JoshuaKGoldberg opened this issue Oct 13, 2022 · 1 comment · Fixed by #6138
Closed
2 tasks done
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating

Comments

@JoshuaKGoldberg
Copy link
Member

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

Spiritual successor to #5242, and following up on https://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 and mostly only place to view documentation, including type descriptions such as parserOptions. 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!

@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for maintainers to take a look documentation Documentation ("docs") that needs adding/updating labels Oct 13, 2022
@bradzacher
Copy link
Member

bradzacher commented Oct 13, 2022

Related to #5090?

@bradzacher bradzacher changed the title Docs: Consider surfacing remaining docs from repo Markdown files ion the website Docs: Consider surfacing remaining docs from repo Markdown files on the website Oct 24, 2022
@bradzacher bradzacher added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for maintainers to take a look labels Oct 24, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating
Projects
No open projects
Status: Done
2 participants