[ECO-1928] Proofread docs site, enforce consistent cspell escapes (#151)

.github/workflows/link-checker.yaml

@@ -1,4 +1,5 @@
-# cspell:words lycheeverse, micalevisk
+# cspell:word lycheeverse
+# cspell:word micalevisk
 ---
 jobs:
   linkChecker:

.github/workflows/pre-commit.yaml

@@ -1,8 +1,8 @@
-# cspell:words pydeps
-# cspell:words pylint
-# cspell:words snok
-# cspell:words venv
-# cspell:words virtualenvs
+# cspell:word pydeps
+# cspell:word pylint
+# cspell:word snok
+# cspell:word venv
+# cspell:word virtualenvs
 ---
 env:
   POETRY_VERSION: '1.8.2'

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-<!--- cspell:words wxyz -->
+<!--- cspell:word wxyz -->
 
 # Contribution Guidelines
 

cfg/cspell-dictionary.txt

@@ -16,6 +16,7 @@ counterparties
 cpamm
 cunha
 dango
+defi
 devnet
 diya
 econia

doc/blackpaper/.gitignore

@@ -1,4 +1,5 @@
-# cspell:words latexmk, synctex
+# cspell:word latexmk
+# cspell:word synctex
 *.aux
 *.bak
 *.fdb_latexmk

doc/blackpaper/calculations.py

@@ -1,4 +1,4 @@
-# cspell:words texttt
+# cspell:word texttt
 from math import isclose, sqrt
 
 A = 10_000.0

doc/blackpaper/main.tex

@@ -1,4 +1,5 @@
-% cspell:words keefer, zinsmeister
+% cspell:word keefer
+% cspell:word zinsmeister
 
 \documentclass[table, twocolumn]{article}
 \usepackage{amsmath}

doc/doc-site/docs/about/about.md

@@ -2,17 +2,14 @@
 slug: /
 title: ⬛ Welcome to emojicoin.fun
 hide_title: false
-description: In the ever-evolving landscape of defi, we are thrilled to introduce
+description: Buckle up and enjoy the ride!
 ---
 
-<!--- cspell:words defi -->
-
 ![about](./about.png "about")
 
-In the ever-evolving landscape of defi, we are
-thrilled to introduce its new platform — emojicoin.fun: where all launched
-and tradable coins are emojicoins.
+Say hello to the newest member of the ever-evolving DeFi landscape:
+emojicoin.fun, where all launched and tradable coins are emojicoins.
 
-Our goal is to merge the engaging, expressive nature of emojis with the
-dynamic world of defi, creating a vibrant, fair, and
-user-friendly environment for traders and communities.
+The emojicoin.fun platform merges the engaging, expressive nature of emojis
+with the dynamic world of DefI, enabling a vibrant, fair, and user-friendly
+environment for traders and communities.

doc/doc-site/docs/about/core-values.md

@@ -0,0 +1,48 @@
+---
+slug: /core-values
+title: 🛠️ Core values
+hide_title: false
+description: Accessibility, fairness, and fun
+---
+
+<!---
+cspell:word memecoins
+cspell:word presales
+-->
+
+![build](./build-banner.png "build")
+
+## Accessibility, fairness, and fun
+
+- **Engagement**: Since emojis are universally recognized and loved,
+  emojicoin.fun is instantly engaging and approachable. By using emojis as coin
+  symbols, emojicoin.fun lowers the barrier to entry for those who might find
+  traditional crypto trading intimidating or too complex.
+
+- **Fairly Launched**: In the world of memecoins, new participants frequently
+  fall victim to scams or unfair token supply distributions, and lose funds.
+  The emojicoin.fun platform enables users to launch emojicoins in a fair launch
+  with predefined supply amounts, where transparent distribution is ensured
+  without presales or team allocations.
+
+- **Fun**: The emojicoin.fun platform provides an enjoyable environment for
+  users to engage with the DeFi universe through a simple interface, where there
+  is no house with better odds than the user.
+
+## Community building
+
+- **Social Interaction**: Emojis are inherently social, and are often used to
+  express emotions and ideas in digital communication. The emojicoin.fun
+  platform encourages a community-driven atmosphere where users can bond over
+  their emojicoins through a per-market chat feature based entirely on emojis.
+- **Inclusive Environment**: By leveraging the universal appeal of emojis,
+  emojicoin.fun creates an inclusive trading environment that welcomes users
+  from all walks of life.
+
+## Showcasing the Aptos tech stack
+
+Aptos is not just fast and affordable, it’s one of the quickest and most
+inexpensive decentralized networks in the world. The emojicoin.fun platform
+leverages the powerful Aptos tech stack to showcase what can be done with
+next-generation blockchain technology, with fun and ease. Say goodbye to failed
+transactions and high gas fees, and say hello to joy!

doc/doc-site/docs/about/emojicoin-LP.md

@@ -2,42 +2,44 @@
 slug: /emojicoin-LP
 title: ⛲ Emojicoin LP
 hide_title: false
-description: AMMs, such as those used on the emojicoin platform, enable the creation
+description: Liquidity pools and yield farming
 ---
 
 ![LP](./LP.png "LP")
 
-AMMs, such as those used on the emojicoin platform, enable the creation of
-liquidity pools containing tokens X and Y (e.g., emojicoin and APT).
-The initial ratio of these tokens sets their starting relative price,
-while the liquidity curve dictates price changes with each swap transaction.
+Constant-product automated market makers (CPAMMs), like those used on
+emojicoin.fun, automatically set the trading price of two token, in this case an
+emojicoin denominated in APT. The initial ratio of these tokens sets price at
+the start of the CPAMM, while the liquidity curve dictates price changes for
+each swap transaction.
 
-## How It Works
+## How it works
 
-### 1. Swapping Tokens
+### 1. Swapping tokens
 
 - Users swap one token for another, paying a small transaction fee.
 
-### 2. Providing Liquidity
+### 2. Providing liquidity
 
-- Liquidity providers (LPs) contribute both X and Y tokens to the pool.
+- Liquidity providers (LPs) contribute both emojicoins and APT to the pool.
 - In exchange, LPs receive LP tokens, representing their share in the pool,
-  which are needed to withdraw their liquidity.
-- LPs earn a portion of the transaction fees from swaps.
+  which are required to withdraw their liquidity.
+- LPs earn a portion of the transaction fees from swaps, which are automatically
+  reinvested in the pool after each swap.
 
-## Key Concept - Constant Function
+## Constant function (key concept)
 
-Most AMMs, including Uniswap v2, use a Constant Function to calculate the
+CPAMMs, popularized by Uniswap v2, use a constant function to calculate the
 relative prices of the two tokens. This formula takes the following form:
 
 $$
-X*Y=K
+X \cdot Y = K
 $$
 
-- X = Emojicoin
-- Y  = APT
-- K = Constant Product
+- $X$ = Emojicoin
+- $Y$ = APT
+- $K$ = Constant
 
 This design ensures that the pool maintains its liquidity and cannot be
-completely drained. The standard liquidity curve function introduced
-by Uniswap v2 is crucial for price stability and availability of liquidity.
+completely drained. The standard liquidity curve function introduced by Uniswap
+v2 is crucial for price stability and liquidity availability.

doc/doc-site/docs/about/how-it-works.md

@@ -1,74 +1,75 @@
 ---
 slug: /how-it-works
-title: ⚙️ How It Works
+title: ⚙️ How it works
 hide_title: false
-description: Bonding Curve Enabled Launchpad
+description: Bonding curve, state transition, and more
 ---
 
 ![gear](./gear-banner.png "gear")
 
-## Bonding Curve Enabled Launchpad
+## Bonding curve, state transition, and more
 
-When a new emojicoin launches, its pricing
-mechanics are defined as an abridged Concentrated Liquidity Automated Market
-Maker (CLAMM) with a single price range. Once the market cap of the emojicoin
-reaches 45,000 APT value, the money used to purchase the coin by traders is
-deployed to an emojicoin AMM pool.
+When a new emojicoin launches, its trading mechanics are dictated by a bonding
+curve where the price of the emojicoin is a function of circulating supply.
+Specifically, the bonding curve is implemented as a concentrated liquidity
+automated market maker (CLAMM) with a single price range.
 
-## Emojicoin or Else
+Once the market capitalization of the emojicoin reaches 45,000 APT, the APT in
+the CLAMM is burned into a constant-product automated market maker (CPAMM),
+along with emojicoin reserves set aside at the market launch. This mechanism
+ensures ample liquidity after the state transition, and a constant price
+throughout the state transition. Moreover, after the bonding curve state
+transition, anyone can provide liquidity into the CPAMM!
 
-The only coins that can be launched are emojicoins that are from the
-standardized [Unicode emoji library].
+## Emojicoin or else
 
-## Emojicoin AMM Pool
+The only coins that can be launched are emojicoins from the
+[Unicode emoji library].
 
-The emojicoin AMM follows the popular and standardized Uniswap v2 design:
+## Emojicoin CPAMM Pool
+
+The emojicoin CPAMM follows the constant-product equation popularized by Uniswap
+v2:
 
 $$
 X \cdot Y = K
 $$
 
-## Life Cycle of Emojicoin: Launchpad to Pool
+## Emojicoin lifecycle: launch to pool
 
-**Introduction**: Congratulations! You've decided to take on the daring journey
-of parenthood and give birth to a beautiful emojicoin. Econia is your favorite
-protocol on the Aptos blockchain, so you decide to name your fictional baby
-emojicoin after her.
+**Introduction**: Congratulations! You've decided to launch an emojicoin! Head
+on over to emojicoin.fun for a seamless experience, powered by the Aptos
+blockchain.
 
-Unlike birthing a human child, giving birth to your beautiful Econia emojicoin
-is painless and cheap by leveraging the Aptos blockchain. We'll now walk you
-through your emojicoin's lifecycle.
+### First steps: launch your emojicoin
 
-### First Baby Steps: Launch your emojicoin
+Launching an emojicoin costs just 1 APT! Note the following:
 
-- With just 1 APT, you can launch your emojicoin — We don't believe in screwing
-  over new parents with expensive medical bills.
+- Single emojis and emoji combinations are supposed, as long as the total number
+  of bytes is 10 or less.
+- Only one market may be launched for a given emoji combination (emojicoin
+  markets are canonical).
+- Emojis that became part of the [Unicode emoji library] after the launch of
+  emojicoin.fun are not supported.
 
-### Growing Up: Exiting the Bonding Curve
+### Growing up: exiting the bonding curve
 
-- Emojicoins are like just like humans, as they grow up and mature they want to
-  leave the house to take the world on their own.
-- The emojicoin.fun platform utilizes a bonding curve for initial price
-  discovery to take place. - The bonding curve is essentially an emojicoin's
-  home. The way your emojicoin matures is depicted by the size of its market
-  cap.
-- The market cap size required to leave the bonding curve = 45,000 APT.
-  For the emojicoin to reach a 45,000 APT market cap, it must have a net
-  buy/sell pressure of +10,000 APT.
+As users buy or sell against the bonding curve, the market capitalization of the
+emojicoin changes. Once 10,000 APT of cumulative sell pressure has pushed the
+bonding curve up to a market capitalization up to 45,000 APT, the emojicoin
+leaves the bonding curve.
 
-### Going to College: Emojicoin Liquidity Pools
+### Going to college: emojicoin liquidity pools
 
-- Once your emojicoin reaches a 45,000 APT market cap size, the coin's market
-  experiences a 'state change' — The 10,000 APT used to purchase the coin is
-  deposited into an emojicoin AMM Liquidity Pool, alongside 23% of the emojicoin
-  token supply. This 'state change' is like your emojicoin baby now going to
-  college and joining a sorority. This Liquidity Pool is locked and its LP
-  tokens to represent it are burned — it can never be removed.
-- The emojicoin in this LP is now available for users to liquidity farm, and
-  of course still be available for trading.
+Once an emojicoin's market capitalization reaches 45,000 APT, the underlying
+market undergoes a state transition: the 10,000 APT that has been deposited into
+the bonding curve is transferred into an emojicoin CPAMM liquidity pool,
+alongside roughly 23% of the remaining emojicoin token supply that has not yet
+gone into circulation. The LP coins generated from this step are then burned
+into the pool to ensure continued market liquidity. Note that this entire step
+is autonomous (handled by the protocol itself without any human intervention).
 
-We understand watching your child grow up is bittersweet, but it's a natural
-part of life and you should be proud of what you've accomplished (like breaking
-out of the bonding curve)!
+Once an emojicoin has left the bonding curve, users may earn yield on their
+emojicoins by providing liquidity to the new CPAMM liquidity pool!
 
 [unicode emoji library]: https://www.unicode.org/emoji/charts/full-emoji-list.html

doc/doc-site/docs/resources/audit.md

@@ -4,4 +4,4 @@ title: 🧑‍💻 Audit
 hide_title: false
 ---
 
-Coming soon.
+Coming soon!

doc/doc-site/docs/resources/bug-submission-form.md

@@ -1,8 +1,11 @@
 ---
 slug: /bug-submission-form
-title: 🐞 Bug Submission Form
+title: 🐛➡️🦋 Bug submission form
 hide_title: false
-description: Fill out the form to submit bugs.
+description: Help catch bugs and give them the love they need
 ---
 
-Fill out the form to submit bugs: <https://form.typeform.com/to/mMylFJQo>
+Help catch unloved bugs 🐛🐛🐛 early, so they can be nurtured until they
+metamorphose into beautiful adult forms and fly away 🦋🦋🦋
+
+Submit bugs here: <https://form.typeform.com/to/mMylFJQo>