Correct typos and refs errors in docs (#186)

Author: wachulski

docs/source/conf.py

@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'usedapp'
-copyright = '2020 Ethworks sp z o.o.'
+copyright = '2021 Ethworks sp z o.o.'
 author = 'Ethworks team'
 
 
@@ -27,7 +27,10 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx_tabs.tabs']
+extensions = [
+    'sphinx_tabs.tabs',
+    'sphinx.ext.autosectionlabel'
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -50,4 +53,8 @@
 html_logo = '_static/logo-square.png'
 html_theme_options = {
   'logo_only': True,
-}
+}
+
+# Allows for cross-refs without refs ambiguity, e.g. :ref:`core/hooks`
+# https://www.sphinx-doc.org/en/master/usage/extensions/autosectionlabel.html#configuration
+autosectionlabel_prefix_document = True

docs/source/core.rst

@@ -12,7 +12,7 @@ Provides basic services for a DApp. It combines the following components: ``<Con
 
 *Properties:*
 
-- ``config: Partial<Config>``: configuration of the Dapp, see `Config`_
+- ``config: Partial<Config>``: configuration of the DApp, see `Config`_
 
 *Example:*
 
@@ -171,7 +171,7 @@ This function is used for debouncing multicall until enough calls are aggregated
 
 - ``first: T`` - first variable to be debounced
 - ``second: U`` - second variable to be debounced
-- ``delay: number`` - deboune time - amount of time in ms 
+- ``delay: number`` - debounce time - amount of time in ms
 
 **Returns**
 
@@ -213,7 +213,7 @@ Returns connection state and functions that allow to manipulate the state.
     - ``chainId: ChainId`` - current chainId (or *undefined* if not connected)
     - ``library: Web3Provider`` - an instance of ethers `Web3Provider <https://github.com/EthWorks/useDapp/tree/master/packages/example>`_ (or *undefined* if not connected)
     - ``active: boolean`` - returns if provider is connected (read or write mode)
-    - ``activateBrowserWallet()`` - function that will inititate connection to browser web3 extension (e.g. Metamask)
+    - ``activateBrowserWallet()`` - function that will initiate connection to browser web3 extension (e.g. Metamask)
     - ``async activate(connector: AbstractConnector, onError?: (error: Error) => void, throwErrors?: boolean)`` - function that allows to connect to a wallet
     - ``async deactivate()`` - function that disconnects wallet
     - ``error?: Error`` - an error that occurred during connecting (e.g. connection is broken, unsupported network)
@@ -314,7 +314,7 @@ Mapping of ``ChainId``'s to node URLs to use in read-only mode.
 List of intended supported chains. If a user tries to connect to an unsupported chain an error value will be returned by `useEthers`.
 
 **Default value:**
-``[ChainId.Mainnet, ChainId.Gorli, ChainId.Kovan, ChainId.Rinkeby, ChainId.Ropsten, ChainId.xDai]``
+``[ChainId.Mainnet, ChainId.Goerli, ChainId.Kovan, ChainId.Rinkeby, ChainId.Ropsten, ChainId.xDai]``
 
 **pollingInterval**
 Polling interval for a new block.
@@ -406,7 +406,7 @@ ChainId
 Enum that represents chain ids.
 
 **Values:**
-``Mainnet, Gorli, Kovan, Rinkeby, Ropsten, xDai``
+``Mainnet, Goerli, Kovan, Rinkeby, Ropsten, xDai``
 
 
 Helpers
@@ -498,7 +498,7 @@ Returns if a given chain is a testnet.
 shortenAddress
 ==============
 
-Returns short representation of address or throws an error if address is incorrent.
+Returns short representation of address or throws an error if address is incorrect.
 
 **Parameters**
 
@@ -514,13 +514,13 @@ Returns short representation of address or throws an error if address is incorre
   shortenAddress('6E9e7A8Fb61b0e1Bc3cB30e6c8E335046267D3A0')
   // 0x6E9e...D3A0
 
-  shortenAddress("i'm not an addres")
+  shortenAddress("i'm not an address")
   // TypeError("Invalid input, address can't be parsed")
 
 shortenIfAddress
 ================
 
-Returns short representation of address or throws an error if address is incorrent.
+Returns short representation of address or throws an error if address is incorrect.
 Returns empty string if no address is provided.
 
 **Parameters**
@@ -540,7 +540,7 @@ Returns empty string if no address is provided.
   shortenIfAddress(undefined)
   // ''
 
-  shortenIfAddress("i'm not an addres")
+  shortenIfAddress("i'm not an address")
   // TypeError("Invalid input, address can't be parsed")
 
 compareAddress

docs/source/guide.rst

@@ -6,7 +6,7 @@ Connecting to network
 
 Read-only
 =========
-To connect to the network in read-only mode, provide ``readOnlyChainId`` and ``readOnlyUrls`` fileds in application configuration.
+To connect to the network in read-only mode, provide ``readOnlyChainId`` and ``readOnlyUrls`` fields in application configuration.
 
 See example configuration below:
 
@@ -24,7 +24,7 @@ Browser wallet
 ==============
 
 To connect to a wallet in a web3-enabled browser, use ``activateBrowserWallet`` returned by ``useEthers()``. 
-Once connected ``account`` variable will be availabe.
+Once connected ``account`` variable will be available.
 
 See example below:
 
@@ -68,7 +68,7 @@ Example
 Example below demonstrates how to manage and use connection.
 
 Application allow to see the balance of Ethereum 2.0 staking contracts in read-only mode.
-When wallet is connected additionaly it shows user's account along with it's balance.
+When wallet is connected additionally it shows user's account along with it's balance.
 
 Example is available `here <https://example.usedapp.io/balance>`_.
 
@@ -169,10 +169,10 @@ Another example is useTokenAllowance hook. Instead of balanceOf, we use allowanc
 The *useContractCall* hook will take care of updating the balance of new blocks.
 The results are deferred so that the hook does not update too frequently.
 
-In our custom hooks we can use any standard react hooks, custom react hooks and useDApp hooks.
+In our custom hooks we can use any standard react hooks, custom react hooks and useDapp hooks.
 Rules of hooks apply.
 
-Documentation for hooks is available `here <file:///Users/marek/Projects/useDapp/docs/dist/html/core.html#hooks>`_.
+Documentation for hooks is available :ref:`here <core:Hooks>`.
 
 
 Using hooks considerations