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

[Docs] Guides & Tutorials improvement #6676

Merged
merged 56 commits into from
Jan 7, 2024
Merged

Conversation

SantiagoDevRel
Copy link
Member

Description

Hi guys, I made some major changes in the structure of the categories (folders and files), rewrote some texts, fixed some typos, cleaned some code (formatting), added some other code samples, added some things(e.g, wallet, and accounts section) and created the Getting started guide, also I removed the glossary in the sidebar and added it to the guides and tutorials part.

Feel free to go to the branch guides_improvement and run yarn start to see in the local environment all the changes.

I didn't change the events subscription folder at all since I wasn't able to follow the guide/interact with logs.

Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see that every single quot has been changed to double quot. Like import { Web3PluginBase } from 'web3'; is changed to import { Web3PluginBase } from "web3";.

There is no right or wrong here. But this is not our coding-style. And if we copy code from our code base it will be single quot always. As if we write double quot in our code, our prettifier configuration will change it to single quot.

So, could you please revert back to single quotes?

Thanks,

@SantiagoDevRel
Copy link
Member Author

@Muhammad-Altabba Thanks for the heads up, I just changed it in the last commit.

Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regarding the Providers Tutorials, please, after splitting them the Prerequisites section needs to be updated as no need to mention both Ganache and Geth.

docs/docs/guides/web3_providers_guide/truffle.md Outdated Show resolved Hide resolved
docs/docs/guides/web3_providers_guide/truffle.md Outdated Show resolved Hide resolved
@SantiagoDevRel SantiagoDevRel merged commit 65a9862 into 4.x Jan 7, 2024
61 of 66 checks passed
@SantiagoDevRel SantiagoDevRel deleted the guides_improvement branch January 7, 2024 20:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Relates to project wiki or documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants