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.

Sign up for GitHub

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

Jump to bottom

📝 Docs: Rephrase "New in ..." notices on versions to say "Since ..." #5166

Closed
3 tasks done
JoshuaKGoldberg opened this issue Jul 3, 2024 · 3 comments · Fixed by #5262
Closed
3 tasks done

📝 Docs: Rephrase "New in ..." notices on versions to say "Since ..." #5166

JoshuaKGoldberg opened this issue Jul 3, 2024 · 3 comments · Fixed by #5262
Labels
area: documentation anything involving docs or mochajs.org status: accepting prs Mocha can use your help with this one!

Comments

@JoshuaKGoldberg
Copy link
Member

Documentation Request Checklist

Overview

The docs on mochajs.org include a lot of notices like https://mochajs.org/#-watch-ignore-filedirectoryglob:

New in v7.0.0

v7.0.0 came out 4 years ago. We're on 10.x now. I don't think we need to keep any "New in" notices prior to 10.

Additional Info

No response
@JoshuaKGoldberg JoshuaKGoldberg added area: documentation anything involving docs or mochajs.org status: in triage a maintainer should (re-)triage (review) this issue labels Jul 3, 2024
@voxpelli
Copy link
Member

voxpelli commented Aug 5, 2024

I like what Node.js does with their Since: 7.0.0, maybe keep them but change the wording to that?

@JoshuaKGoldberg
Copy link
Member Author

Sure, works for me.

Out of curiosity: for versions > a few years old, what benefit do you see from keeping these around?

@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Mocha can use your help with this one! and removed status: in triage a maintainer should (re-)triage (review) this issue labels Aug 6, 2024
@JoshuaKGoldberg JoshuaKGoldberg changed the title 📝 Docs: Remove "New in ..." notices on versions past the latest major 📝 Docs: Rephrase "New in ..." notices on versions to say "New in" Aug 6, 2024
@JoshuaKGoldberg JoshuaKGoldberg changed the title 📝 Docs: Rephrase "New in ..." notices on versions to say "New in" 📝 Docs: Rephrase "New in ..." notices on versions to say "Since" Aug 6, 2024
@JoshuaKGoldberg JoshuaKGoldberg changed the title 📝 Docs: Rephrase "New in ..." notices on versions to say "Since" 📝 Docs: Rephrase "New in ..." notices on versions to say "Since ..." Aug 6, 2024
@voxpelli
Copy link
Member

voxpelli commented Aug 6, 2024

Same value as in Node, if one updates from an old version. Not very important to me though

TG199 added a commit to TG199/mocha that referenced this issue Nov 24, 2024
@TG199
docs: replace "New in" with "Since" in version annotations
cf77148 
* Change version annotations from "New in vX.Y.Z" to "Since vX.Y.Z"
* Align with Node.js documentation style convention
* Improve clarity for users upgrading from older versions

Closes mochajs#5166
@TG199 TG199 mentioned this issue Nov 24, 2024
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Dec 9, 2024
@TG199 @JoshuaKGoldberg
docs: replace "New in" with "Since" in version annotations (#5262)
6f10d12 
* docs: replace "New in" with "Since" in version annotations

* Change version annotations from "New in vX.Y.Z" to "Since vX.Y.Z"
* Align with Node.js documentation style convention
* Improve clarity for users upgrading from older versions

Closes #5166

* Update docs/index.md

Co-authored-by: Josh Goldberg ✨ <[email protected]>

* fix typo

---------

Co-authored-by: Josh Goldberg ✨ <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: documentation anything involving docs or mochajs.org status: accepting prs Mocha can use your help with this one!
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: replace "New in" with "Since" in version annotations TG199/mocha
2 participants
@voxpelli @JoshuaKGoldberg