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

Implement tabbed code examples in documentation for language and package managers #4836

Open
schaable opened this issue Feb 8, 2024 · 6 comments
Labels
status:ready This issue is ready to be worked on type:docs Documentation-related issue type:improvement

Comments

@schaable
Copy link
Member

schaable commented Feb 8, 2024

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.

@schaable schaable added type:docs Documentation-related issue type:improvement status:ready This issue is ready to be worked on labels Feb 8, 2024
@fvictorio fvictorio added this to Hardhat Feb 8, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Hardhat Feb 8, 2024
@lilpolymath
Copy link
Contributor

lilpolymath commented Feb 8, 2024

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.

@kanej
Copy link
Member

kanej commented Feb 9, 2024

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.

@lilpolymath
Copy link
Contributor

@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.

@kanej
Copy link
Member

kanej commented Feb 9, 2024

@lilpolymath we are still in the planning stages.
Any PRs that make our docs more consistent are always appreciated.

@lilpolymath
Copy link
Contributor

@kanej Alright then. Is there anyone who works on the documentation full-time that I can sync efforts with?

@kanej
Copy link
Member

kanej commented Feb 9, 2024

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:ready This issue is ready to be worked on type:docs Documentation-related issue type:improvement
Projects
Status: Backlog
Development

No branches or pull requests

3 participants