docs: distribute examples into relevant guides - Githubissues

ethereum / web3.py

A python interface for interacting with the Ethereum blockchain and ecosystem.

http://web3py.readthedocs.io

MIT License

4.89k stars 1.67k forks source link

docs: distribute examples into relevant guides #3383

Closed wolovim closed 2 months ago

wolovim commented 2 months ago

What was wrong?

the Examples guide has had random bits glommed onto it over the years. its ~useful, but a semi-random pile of ideas.

How was it fixed?

break examples out into their relevant guides (e.g., contract stuff into the contract guide), adding a new Examples section in those guides where necessary
toss out duplicates/stale stuff
delete the Examples page, further slimming down the list of guides
(leaving more cleanup within the guides for future PRs)

Todo:

[x] Clean up commit history
[x] Add or update documentation related to these changes
[x] Add entry to the release notes

Cute Animal Picture

Put a link to a cute animal picture inside the parenthesis-->

pacrob commented 2 months ago

While you're in here, I noticed that the ordered list after The following example runs through these steps: on line 61 of web3.contract.rst is not rendering correctly. Can fix?