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

Rule docs on website should show the latest version, not what's in the main branch #5939

Closed
2 tasks done
sindresorhus opened this issue Nov 8, 2022 · 4 comments · Fixed by #6055
Closed
2 tasks done
Assignees
Labels
documentation Documentation ("docs") that needs adding/updating

Comments

@sindresorhus
Copy link

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

Suggested Changes

I wasted a lot of time now because I thought the fixStyles option for the consistent-type-imports rule here was available in the latest release since it's shown on the website: https://typescript-eslint.io/rules/consistent-type-imports/#fixstyle

It's expected that a website shows docs for the latest available release, not what's in the main branch.

Affected URL(s)

https://typescript-eslint.io/rules/

@sindresorhus sindresorhus added documentation Documentation ("docs") that needs adding/updating triage Waiting for maintainers to take a look labels Nov 8, 2022
@lsagetlethias
Copy link

Same as the playground that should not used the main branch but the last release. (eslint playground)
Really confusing.

@Josh-Cena
Copy link
Member

The release script is not public, so I'm going to let @JoshuaKGoldberg do it. Basically we just need to run yarn docs:version during release.

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Nov 21, 2022

I'm working on this now. Plan is to:

  1. Short term: have Netlify pull from a docs website branch that's only updated on releases
  2. Long term: look into Docusaurus versioning or a similar system

@JoshuaKGoldberg
Copy link
Member

Ok, the website should be pinned to the latest stable released version now. #6055 will add an explicit version number to it too, but this issue is technically resolved. So I'll close it now.

Thanks for posting @sindresorhus, @lsagetlethias, and everyone who 👍d! Please let us know in new issues if there are any other website bugs or features you'd like to see. ❤️

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation ("docs") that needs adding/updating
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants