Commit Graph

9 Commits

Author SHA1 Message Date
Jeff Schroeder b175dd43c8
docs: quit the spelling spam typo fix PRs with cspell magic (#3845)
* Add cspell configuration and custom dictionary

The goal is to cut down on both incoming tyops, and well meaning but
spammy tyop fix PRs.

To run cspell locally install it and run:

    cspell '**/*.md' \
        --config cspell.config.yaml \
        --words-only \
        --unique \
        --quiet | sort --ignore-case

* docs: cspell updates

* wormchain: cspell updates

* aptos: cspell updates

* node: cspell updates

* algorand: cspell updates

* whitepapers: cspell updates

* near: cspell updates

* solana: cspell updates

* terra: cspell updates

* cosmwasm: cspell updates

* ethereum: cspell updates

* clients: cspell updates

* cspell updates for DEVELOP document

* github: run cspell github action

* sdk: cspell updates

* github: only run cspell on markdown files

* algorand: EMMITTER --> EMITTER

Suggested-by: @evan-gray

* cspell: removed from dictionary

Suggested-by: @evan-gray

* aptos and node: cspell updates

Suggested-by: @evan-gray

* cosmowasm: doc updates for terra2

Suggested-by: @evan-gray

* algorand: cspell updates

Suggested-by: @evan-gray

* algorand: cspell updates

Suggested-by: @evan-gray

* cspell: updated custom word dictionary

This resorts the dictionary and adds a few new words from the
algorand/MEMORY.md document around varints and integers.

* cspell: sort the dictionary how vscode does it

On macOS the sorting is locale dependent. To do this on macOS, you have
to invert the case, do a character insensitive sort, and then invert the
case again:

    LC_COLLATE="en_US.UTF-8" cspell '**/*.md' --config cspell.config.yaml \
        --words-only \
        --unique \
        --no-progress \
        --quiet \
    | tr 'a-zA-Z' 'A-Za-z' \
    | sort --ignore-case \
    | tr 'a-zA-Z' 'A-Za-z'

This requires the `LC_COLLATE` variable to be set to `en_US.UTF-8`, or it
will not do the right thing.

* docs: grammar clean up

---------

Co-authored-by: Evan Gray <battledingo@gmail.com>
2024-03-20 15:40:02 -04:00
alex 8b39c1a9bf docs: fix typos with spell checker 2023-12-21 15:24:20 -06:00
iwantanode 6c35b89e0c fix typo 0007_governor.md 2023-12-12 11:24:41 -06:00
Jeff Schroeder 81f411dbf9 whitepapers: update governor link to running a spy 2023-09-13 14:32:17 -04:00
tbjump 57760882d8
whitepapers: Update Governor whitepaper (#2401)
* whitepapers: Update Governor whitepaper

* whitepapers: address reviewer feedback

* whitepapers/gov: remove FAQs

---------

Co-authored-by: tbjump <>
2023-09-01 14:17:08 -04:00
Hendrik Hofstadt ff186e441a rename dev.v2 to main
Change-Id: Idfc6f88de7ee3c190a01c2196dc0bc4da91cbe4c
2022-11-29 10:43:07 -05:00
wonge97 f49c86208b
docs: governor update (#1524)
* Update governor documents

* governor: whitepaper update, auto-release

* docs: update hours spec to 24

Co-authored-by: Evan Gray <battledingo@gmail.com>
2022-09-12 21:28:20 -04:00
Csongor Kiss 8818d4b8f0 docs: Clarify objective in governor whitepaper
Also include a link to the whitepaper from the docs
2022-08-12 14:58:22 +01:00
wonge97 09b33552df Chain Governor
Opening this PR for open feedback on a security feature that Guardians can optionally opt into that would limit the amount of notional value that can be transferred out of a given chain in a given time frame -- this would reduce the damage to the bridge during an existential threat scenario.
2022-08-10 12:20:34 -04:00