Skip to content

Add context to index.rst and docs categories #1671

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 15, 2020
+51 −16
Merged

Add context to index.rst and docs categories #1671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1ba31a
add context to index.rst and docs categories
wolovim Jun 12, 2020
9f8aab9
add newsfragment
wolovim Jun 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 48 additions & 16 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,43 +1,70 @@
Web3.py
=======
Introduction
============

Web3.py is a python library for interacting with Ethereum. Its API is derived
from the `Web3.js`_ Javascript API and should be familiar to anyone who has
used ``web3.js``.
Web3.py is a Python library for interacting with Ethereum.

It's commonly found in `decentralized apps (dapps)`_ to help with
sending transactions, interacting with smart contracts, reading
block data, and a variety of other use cases.

Contents
--------
The original API was derived from the `Web3.js`_ Javascript API,
but has since evolved toward the needs and creature comforts of
Python developers.

Getting Started
---------------

Your next steps depend on where you're standing:
Copy link
Contributor

@cburgdorf cburgdorf Jun 15, 2020

Choose a reason for hiding this comment

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

Skimming over the web3.py docs I noticed that the docs are using the second person "you" form a lot so I'm not suggesting to change it here. I just wanted to point out that the majority of our other projects use the first-person "we" form. There's no right or wrong, it's just a matter of picking one and staying consistent. I just wanted to point it out and draw your attention to our little guide line on docs: https://github.com/ethereum/snake-charmers-tactical-manual/blob/master/documentation.md#narrative-perspective

But then again, I'm not suggestion to change the narrative perspective for web3.py, I just wanted to raise awareness that this is slightly different then e.g. what Trinity uses.

Copy link
Member Author

@wolovim wolovim Jun 15, 2020

Choose a reason for hiding this comment

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

Thanks for highlighting this. I like to keep a casual tone, but I'm probably guilty of some inconsistency, so I'll keep an eye on it. Indeed the rest of the docs (or at least the few pages I just scanned) utilize the "you" form, so seems reasonable to continue the trend. If we decide to change course at some point, I won't fight it too hard ;)


- Unfamiliar with Ethereum? `ethereum.org`_
- Looking for Ethereum Python tutorials? `ethereum.org/python`_
- Ready to code? :ref:`quickstart`
- Need help debugging? `StackExchange`_
- Want to chat? `Gitter`_

Table of Contents
-----------------

.. toctree::
:maxdepth: 1
:caption: Intro

quickstart
overview
releases

.. toctree::
:maxdepth: 1
:caption: Guides

node
providers
examples
troubleshooting
v5_migration
v4_migration
web3.eth.account
filters
contracts
ens_overview
middleware
internals
abi_types
ethpm
ens_overview
v5_migration
v4_migration

.. toctree::
:maxdepth: 1
:caption: API

web3.main
web3.eth
web3.eth.account
web3.pm
web3.net
web3.miner
web3.geth
web3.parity
gas_price
ens
ethpm
internals
abi_types
releases

Indices and tables
------------------
Expand All @@ -47,4 +74,9 @@ Indices and tables
* :ref:`search`


.. _Web3.js: https://github.com/ethereum/wiki/wiki/JavaScript-API
.. _decentralized apps (dapps): https://ethereum.org/dapps/
.. _Web3.js: https://web3js.readthedocs.io/
.. _ethereum.org: https://ethereum.org/what-is-ethereum/
.. _ethereum.org/python: https://ethereum.org/python/
.. _StackExchange: https://ethereum.stackexchange.com/questions/tagged/web3.py
.. _Gitter: https://gitter.im/ethereum/web3.py
2 changes: 2 additions & 0 deletions docs/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _quickstart:

Quickstart
==========

Expand Down
1 change: 1 addition & 0 deletions newsfragments/1671.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Breaks up links into three categories (Intro, Guides, and API) and adds content to the index page: a lib introduction and some "Getting Started" links.