Use Admonitions on website

[SimenB]

🚀 Feature Proposal

Our current docs are full of "Note:" and its ilk, sometimes as a quote (>), sometimes in italics etc.. We should instead use admonitions both since they look better, but also to have a consistent way of adding this type of info and it can differentiate between notes, tips etc..

[Ash-KODES]

Can I contribute for this issue?

[SimenB]

Yeah, any help appreciated!

[SimenB]

I'd search for "Note" in docs/ and website/versioned_docs and replace most of them with :::note or :::tip (or some other if that makes more sense in context).

You should do just docs/ first, then open a PR so I can review - no need to spend time on the versioned docs until we're happy with the main ones! 🙂

[Ash-KODES]

ok,I am on it:)

[Ash-KODES]

@Biki-das you should had asked before opening a PR since I had claimed the issue beforehand,I was going though changes

[Biki-das]

@Biki-das you should had asked before opening a PR since I had claimed the issue beforehand,I was going though changes

Sorry for that, i didn't saw it.
Well here's what you can do, i have just suggested changes for the docs, you can go through my docs changes and apply them to the versioned docs, this way you can send a PR.

[weidehai]

i think we can create a task list,people who want to participate and contribute shuold create a issue link to a specified task first,and then pull request for this issue,one task should be linked only one issue at a time to prevent conflict
@SimenB

[Biki-das]

I already worked on the main docs part, now someone can take Versioned docs to work on

[SimenB]

Since @Ash-KODES claimed the issue, I think it's fair for them to be able to contribute it if they want. It might make sense to split it up and do e.g. 5 files at a time, but that should be up to @Ash-KODES.

[Biki-das]

Since @Ash-KODES claimed the issue, I think it's fair for them to be able to contribute it if they want. It might make sense to split it up and do e.g. 5 files at a time, but that should be up to @Ash-KODES.

yeah he has agreed to work on the versioned docs

[Biki-das]

hey @Ash-KODES , you can work on the versioned docs part once i update the main docs correctly

[Ash-KODES]

Ok then,I will work on versioned doc,,Np:)

[SimenB]

BTW, don't work on 27.0, 27.1, 27.2 or 27.4 - those will be deleted when Jest 28 is released soon. 27.5 will be renamed to 27.x.

[Biki-das]

BTW, don't work on 27.0, 27.1, 27.2 or 27.4 - those will be deleted when Jest 28 is released soon. 27.5 will be renamed to 27.x.

cc @Ash-KODES

[Ash-KODES]

I will making different PRs for different files as mentioned in biki's PR

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 30 days.

[SimenB]

Ergh, not done yet 😅

[Mr-peipei]

Which one is left.
I'll fix it.

[paulreece]

Hi I believe I found and replaced every single usage of note, etc and replaced it with admonitions. My PR is here

[paulreece]

@SimenB Please let me know if I have implemented all the necessary admonitions, I'm happy to update it if necessary. My PR is here

[miguelfdezc]

Hi! I would like to contribute if there's anything left I can help with @SimenB

[miguelfdezc]

@paulreece are you still working on the changes? I checked your PR and it says the branch has some conflicts (I guess some parts have been updated after)

[paulreece]

@miguelfdezc @SimenB Thank you for pointing this out. The merge conflicts have now been resolved. All of the admonitions have been implemented and it's ready for merge. My PR is here

[sykalerio]

Hi there,

I'm [Syka Lerioti Elpida], a new contributor interested in helping out with this issue. I'm excited to learn more about testing and would love to get some guidance on how to proceed.

Could you please provide me with more information on what specifically needs to be tested in this issue? Also, if you have any resources or tutorials on testing with Jest that would be really helpful.

Thanks, and looking forward to contributing!

Best,
Elpida

[ashutosh887]

I would like to work on this issue

[mrazauskas]

Thank you all contributing to this issue. Thank you for the interest to help as well.

I was looking through the files once again. Can’t spot any missing admonitions anymore. So this is done 🎉 🎉 🎉

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.