-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
docs: move remaining docs files into website #5984
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: move remaining docs files into website #5984
Conversation
Thanks for the PR, @JoshuaKGoldberg! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
[[redirects]] | ||
from = "/docs" | ||
to = "/getting-started" | ||
|
||
[[redirects]] | ||
from = "/docs/development/architecture/asts" | ||
to = "/blog/asts-and-typescript-eslint" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI, Netlify can use a separate _redirects
file (https://docs.netlify.com/routing/redirects/), which IMO is more compact and maintainable
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, that is nicer! Thanks 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh but the .toml
version has more options available? Now I'm conflicted...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
noice - thanks for doing this!
finally website-first!
🙄 moving to #6138 because GitHub seems to no longer play nicely with chained PRs this way. |
PR Checklist
Overview
This PR finishes moving most of our documentation onto the site itself. It applies a couple of big changes:
architecture/*
pages, so they benefit from the richness of the Docusaurus sitedocs/
from pages, as "docs" is implied by being on the site, and this shortens URLsIt also applies a few cleanups around those changes:
Moved the ASTs page to a blog post, with more friendly information and added contextchore: added blog article: 'ASTs and TypeScript-ESLint' #6039netlify.toml
redirects for the old pathsUPPER_CASE.md
toSentence_Case.md
(not strictly necessary, I was just tired of the file tree screaming at me)Sorry that it's such a big PR 🙃 these changes all ended up linking together. But I'm very excited that it should be the last overhaul I do for a while to the docs structure!