diff --git a/docs/glossary.md b/docs/glossary.md index afdab9abf2..d862dd3a10 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -26,7 +26,7 @@ m / purpose' / coin_type' / account' / change / address - `change` - `0'` or `1'` depending on if the address was generated for moving a transaction's remainder funds (`1`) or is an external address for receiving funds (`0`) - `address` - the index for an address, of which there are 2,147,483,648 possible values (in Firefly these are the individual addresses per each wallet in a single profile) -\* _The added apostrophe indicates a hardened derivation at that level, which means that it is not possible to link a public key with its parent or child public keys via the public keys alone. With this mechanism being used at at least the `account` level, the case of an accidental leak of account-specific keys does __NOT__ compromise other accounts or the master (`m`)._ +\* _The added apostrophe indicates a hardened derivation at that level, which means that it is not possible to link a public key with its parent or child public keys via the public keys alone. With this mechanism being used at least the `account` level, the case of an accidental leak of account-specific keys does __NOT__ compromise other accounts or the master (`m`)._ BIP32 is important as without it, you may not necessarily be able to gain access to your funds - you __must__ know which indices the funds reside on to gain access (i.e. you can know which private / public key-pair to generate from the seed). Do not worry though as Firefly sequentially generates new accounts and addresses, which is what allows the balance finder in the settings to more easily find your funds should they be "lost". @@ -48,7 +48,7 @@ To help understand the technical definition, please read the above description a ## 🌐 IOTA Networks -The IOTA ecosystem contains a variety of networks each with different purposes and use-cases. +The IOTA ecosystem contains a variety of networks each with different purposes and use cases. ### Mainnet diff --git a/docs/guides/developer-tips.md b/docs/guides/developer-tips.md index a690d49fd1..c60881e81e 100644 --- a/docs/guides/developer-tips.md +++ b/docs/guides/developer-tips.md @@ -73,7 +73,7 @@ There are a few steps besides just creating the component file before it can wor #### Backend Firefly uses [wallet.rs](https://github.com/iotaledger/wallet.rs) in the backend to handle functionality around value-based transfers. -See its [REAMDE](https://github.com/iotaledger/wallet.rs#dependencies) for the required dependencies. +See its [README](https://github.com/iotaledger/wallet.rs#dependencies) for the required dependencies. #### Desktop @@ -112,4 +112,4 @@ If you want to reset Firefly your profiles are stored in the following places on - MacOS: `$HOME/Library/Application\ Support/Firefly/__storage/` - Linux: `~/.config/Firefly/__storage__/` -For developer/alpha/beta builds you have to look for `Electron`/`'Firefly Shimmer - Alpha'`/`'Firefly Shimmer - Beta'` respectively. \ No newline at end of file +For developer/alpha/beta builds you have to look for `Electron`/`'Firefly Shimmer - Alpha'`/`'Firefly Shimmer - Beta'` respectively. diff --git a/docs/specifications/governance.md b/docs/specifications/governance.md index 1481be8f73..681120d2ce 100644 --- a/docs/specifications/governance.md +++ b/docs/specifications/governance.md @@ -17,11 +17,11 @@ Governance refers to the feature allowing users to vote on important community-w - `holding` - corresponds to "Counting" - `ended` - corresponds to "Closed" - **Governance** - rules and processes to make decisions concerning permissionless applications and platforms -- **Participation** - the interacting with or taking part in an event, either by voting or staking funds +- **Participation** - interacting with or taking part in an event, either by voting or staking funds - **Proposal** - synonymous with voting event, which is an event that contains one or more questions that users can vote on - **Vote** - participating in a voting event, initially by selecting answers (aka votes) for each question on the proposal's ballot then broadcasting a transaction with appropriately structured metadata (so that it can be tracked by the node(s)) - **Voting output** - a designated output to be used for all voting operations (e.g. increasing or decreasing voting power and voting or unvoting for an event) -- **Voting power** - the amount of votes a user can cast for a proposal, which is based off of how much IOTA or SMR he or she has; this **MAY** or **MAY NOT** be the same as a user's total balance, it depends on how much they have manually designated as their voting power +- **Voting power** - the amount of votes a user can cast for a proposal, which is based on how much IOTA or SMR he or she has; this **MAY** or **MAY NOT** be the same as a user's total balance, it depends on how much they have manually designated as their voting power ## Adding a Proposal diff --git a/docs/standard-operating-procedures/development/documentation.md b/docs/standard-operating-procedures/development/documentation.md index 024da42f42..f944bfddd1 100644 --- a/docs/standard-operating-procedures/development/documentation.md +++ b/docs/standard-operating-procedures/development/documentation.md @@ -14,7 +14,7 @@ This SOP is applicable to contributors to the Firefly repository, mainly the cor ## Responsibilities -All members of the Firefly team are responsible for mainintaing documentation, specifically in ensuring its accuracy and relevancy, as we all use this resource and benefit from it being of the highest possible quality. +All members of the Firefly team are responsible for maintaining documentation, specifically in ensuring its accuracy and relevancy, as we all use this resource and benefit from it being of the highest possible quality. ## Processes @@ -36,7 +36,7 @@ To make changes to the documentation within this handbook, begin the process by When making changes to the code, be sure to check whether the comments if the functions, variables, etc. that you're dealing with are up-to-date and accurate. If writing new code that is exported and intended to be used elsewhere, make sure that it is appropriately commented (see the [coding conventions on comments](../../guides/coding-conventions/comments.md)). -Every new folder and page page must have an `icon: ` entry in the top of the its corresponding file (see [Octicons](https://primer.style/octicons/)). +Every new folder and page must have an `icon: ` entry in the top of its corresponding file (see [Octicons](https://primer.style/octicons/)). Lastly, every new folder must have some sort of text describing what its purpose is and what you'll find when looking in it. ## GitHub Wiki