Doc changes to address frequently asked questions

packages/cli/src/commands/election/activate.ts

@@ -1,17 +1,19 @@
 import { sleep } from '@celo/utils/lib/async'
 import { flags } from '@oclif/command'
+import { cli } from 'cli-ux'
 import { BaseCommand } from '../../base'
 import { newCheckBuilder } from '../../utils/checks'
 import { displaySendTx } from '../../utils/cli'
 import { Flags } from '../../utils/command'
 
 export default class ElectionVote extends BaseCommand {
-  static description = 'Activate pending votes in validator elections to begin earning rewards'
+  static description =
+    'Activate pending votes in validator elections to begin earning rewards. To earn rewards as a voter, it is required to activate your pending votes at some point after the end of the epoch in which they were made.'
 
   static flags = {
     ...BaseCommand.flags,
     from: Flags.address({ required: true, description: "Voter's address" }),
-    wait: flags.boolean({ description: 'Wait until all pending votes become activatable' }),
+    wait: flags.boolean({ description: 'Wait until all pending votes can be activated' }),
   }
 
   static examples = [
@@ -33,9 +35,11 @@ export default class ElectionVote extends BaseCommand {
     if (hasPendingVotes) {
       if (res.flags.wait) {
         // Spin until pending votes become activatable.
+        cli.action.start(`Waiting until pending votes can be activated`)
         while (!(await election.hasActivatablePendingVotes(account))) {
           await sleep(1000)
         }
+        cli.action.stop()
       }
       const txos = await election.activate(account)
       for (const txo of txos) {

packages/cli/src/utils/checks.ts

@@ -155,13 +155,13 @@ class CheckBuilder {
 
   isNotAccount = (address: Address) =>
     this.addCheck(
-      `${address} is not an Account`,
+      `${address} is not a registered Account`,
       this.withAccounts((accs) => negate(accs.isAccount(address)))
     )
 
   isSignerOrAccount = () =>
     this.addCheck(
-      `${this.signer!} is Signer or Account`,
+      `${this.signer!} is Signer or registered Account`,
       this.withAccounts(async (accs) => {
         const res = (await accs.isAccount(this.signer!)) || (await accs.isSigner(this.signer!))
         return res

packages/docs/SUMMARY.md

@@ -19,7 +19,7 @@
 - [Celo Protocol](celo-codebase/protocol/README.md)
   - [Consensus](celo-codebase/protocol/consensus/README.md)
     - [Validator Set Differences](celo-codebase/protocol/consensus/validator-set-differences.md)
-    - [Locating Validators](celo-codebase/protocol/consensus/locating-validators.md)
+    - [Locating Nodes](celo-codebase/protocol/consensus/locating-nodes.md)
     - [Ultralight Sync](celo-codebase/protocol/consensus/ultralight-sync.md)
   - [Proof of Stake](celo-codebase/protocol/proof-of-stake/README.md)
     - [Validator Groups](celo-codebase/protocol/proof-of-stake/validator-groups.md)

packages/docs/celo-codebase/protocol/proof-of-stake/README.md

@@ -24,7 +24,7 @@ Most of Celo's Proof of Stake mechanism is implemented as smart contracts, and a
 
 - [`Validators.sol`](https://github.com/celo-org/celo-monorepo/blob/master/packages/protocol/contracts/governance/Validators.sol) handles registration, deregistration, staking, key management and epoch rewards for validators and validator groups, as well as routines to manage the members of groups.
 
-- [`Elections.sol`](https://github.com/celo-org/celo-monorepo/blob/master/packages/protocol/contracts/governance/Elections.sol) manages Locked Gold voting and epoch rewards and runs Validator Elections.
+- [`Election.sol`](https://github.com/celo-org/celo-monorepo/blob/master/packages/protocol/contracts/governance/Election.sol) manages Locked Gold voting and epoch rewards and runs Validator Elections.
 
 In Celo blockchain:
 

packages/docs/command-line-interface/election.md

@@ -6,15 +6,15 @@ description: Participate in and view the state of Validator Elections
 
 ### Activate
 
-Activate pending votes in validator elections to begin earning rewards
+Activate pending votes in validator elections to begin earning rewards. To earn rewards as a voter, it is required to activate your pending votes at some point after the end of the epoch in which they were made.
 
 ```
 USAGE
   $ celocli election:activate
 
 OPTIONS
   --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  (required) Voter's address
-  --wait                                             Wait until all pending votes become activatable
+  --wait                                             Wait until all pending votes can be activated
 
 EXAMPLES
   activate --from 0x4443d0349e8b3075cba511a0a87796597602a0f1