-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Implement tabbed code examples in documentation for language and package managers #4836
Comments
This looks like it is going to be quite an update. Can I work on this? I would like to work on improving the docs. |
Is this mainly in the plugin docs? Or is it in the core guides that we have these inconsistencies? We should keep in mind that we will likely need a major docs overhaul for the upcoming Hardhat V3 effort. But we definitely want to standardize. |
@kanej I skimmed through the docs and it happens in both the plugin docs and the core guides. When is the scheduled release for Hardhat V3? I think it is best to start planning towards overhauling the guides incrementally because of the community. |
@lilpolymath we are still in the planning stages. |
@kanej Alright then. Is there anyone who works on the documentation full-time that I can sync efforts with? |
No, it is a shared responsibility of the team. |
Currently, our docs display code examples inconsistently: some pages use JavaScript, others use TypeScript, and a few use tabs for both. The same applies to the package managers.
To improve user experience, we should standardize using tabs for all code examples to switch between JavaScript | TypeScript and package managers (npm 7+ | npm 6 | yarn | pnpm), similar to what's done here.
The text was updated successfully, but these errors were encountered: