diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 44c215aa..bf9fb243 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -27,7 +27,7 @@ At this point, you should set your `$GOPATH` environment variable, which represents the path to your workspace. By default, `$GOPATH` is set to - `~/go`. You wll also need to add `$GOPATH/bin` to your `PATH`. This ensures + `~/go`. You will also need to add `$GOPATH/bin` to your `PATH`. This ensures that your shell will be able to detect the binaries you install. ```bash @@ -169,7 +169,7 @@ lnd --bitcoin.active --bitcoin.testnet --debuglevel=debug --neutrino.active --ne #### Running lnd using the btcd backend If you are on testnet, run this command after `btcd` has finished syncing. -Otherwise, replace `--bitcoin.testnet` with `--bitcoin.simnet`. If you +Otherwise, replace `--bitcoin.testnet` with `--bitcoin.simnet`. If you are installing `lnd` in preparation for the [tutorial](http://dev.lightning.community/tutorial), you may skip this step. ``` diff --git a/docs/code_contribution_guidelines.md b/docs/code_contribution_guidelines.md index fb8ced77..6c304254 100644 --- a/docs/code_contribution_guidelines.md +++ b/docs/code_contribution_guidelines.md @@ -39,7 +39,7 @@ far more dire consequences than in typical projects where having a small bug is minimal by comparison. In the world of cryptocurrencies, even the smallest bug in the wrong area can cost people a significant amount of money. For this reason, the Lightning Network Daemon (lnd) has a formalized and rigorous -development process (heavily insipred by +development process (heavily inspired by [btcsuite](https://github.com/btcsuite)) which is outlined on this page. We highly encourage code contributions, however it is imperative that you adhere @@ -97,7 +97,7 @@ above may be a bit out of date. Many implementers are currently working on an initial [Version 1 Specification](https://medium.com/@lightningnetwork/lightning-network-meeting-on-interoperability-and-specifications-ea49e47696a4). Once the specification is finalized, it will be the most up-to-date comprehensive document explaining the Lightning Network. As a result, it will -be recommened for newcomers to read first in order to get up to speed. +be recommended for newcomers to read first in order to get up to speed. @@ -286,7 +286,7 @@ all short-[commit messages are to be prefixed according to the convention outlined in the Go project](https://golang.org/doc/contribute.html#change). All commits should begin with the subsystem or package primarily affected by the change. In the case of a widespread change, the packages are to be delimited by -either a '+' or a ','. This prefix seems minor but can be extremly helpful in +either a '+' or a ','. This prefix seems minor but can be extremely helpful in determining the scope of a commit at a glance, or when bug hunting to find a commit which introduced a bug or regression. diff --git a/docs/go-fuzz/README.md b/docs/go-fuzz/README.md index cd43b082..a0f533fd 100644 --- a/docs/go-fuzz/README.md +++ b/docs/go-fuzz/README.md @@ -94,7 +94,7 @@ Wherever a `0` is returned, `go-fuzz` will ignore that input as it has reached an unimportant code path caused by the parser catching the error. If a `1` is returned, the `[]byte` input was parsed successfully and the two `lnwire.Message` objects were indeed equal. This `[]byte` input is then added to the corpus as -a valid message. If a `panic` is reached, serialiation or deserialization failed +a valid message. If a `panic` is reached, serialization or deserialization failed and `go-fuzz` may have found a bug. ### Conclusion ### diff --git a/docs/macaroons.md b/docs/macaroons.md index d83b3fcc..d13cbfe1 100644 --- a/docs/macaroons.md +++ b/docs/macaroons.md @@ -1,7 +1,7 @@ As part of [the `lnd` 0.3-alpha release](https://github.com/lightningnetwork/lnd/releases/tag/v0.3-alpha), we have addressed [issue 20](https://github.com/lightningnetwork/lnd/issues/20), -which is RPC authentictaion. Until this was implemented, all RPC calls to `lnd` +which is RPC authentication. Until this was implemented, all RPC calls to `lnd` were unauthenticated. To fix this, we've utilized [macaroons](https://research.google.com/pubs/pub41892.html), which are similar to cookies but more capable. This brief overview explains, at a basic level,