Merge branch 'release/0.1.0-beta.2'

Author: realfish

.env

@@ -1 +1 @@
-SITE_ROOT=https://docs.dorafactory.org
+NEXT_PUBLIC_SITE_ROOT=https://docs.dorafactory.org

.env.development

@@ -1 +1 @@
-SITE_ROOT=http://localhost:3000
+NEXT_PUBLIC_SITE_ROOT=http://localhost:3000

CHANGELOG.md

@@ -1,6 +1,33 @@
 # CHANGELOG
 
-## [0.1.0-beta.1][0.1.0-beta.1] · 2023-09-23
+## [0.1.0-beta.2][0.1.0-beta.2] · 2023-10-04
+
+### Added
+
+### Changed
+
+- Refactor: Prefix `SITE_ROOT` with `NEXT_PUBLIC_` to streamline environment variable configuration.
+  - Reference: https://nextjs.org/docs/pages/building-your-application/configuring/environment-variables#bundling-environment-variables-for-the-browser
+- Perf: Optimize CLS for Nextra Card images.
+  - Reference: https://web.dev/optimize-cls/
+- Docs: Streamline and reword for README.
+- Build: Update deps to latest versions.
+  - `next`: 13.5.4
+  - `nextra`: 2.13.1
+  - `nextra-theme-docs`: 2.13.1
+- Build: Update devDeps to latest versions.
+  - `@types/node`: 20.8.2
+  - `@types/react`: 18.2.24
+  - `eslint-config-next`: 13.5.4
+  - `postcss`: 8.4.31
+  - `prettier-plugin-tailwindcss`: 0.5.5
+
+### Fixed
+
+- Fix: Change preparation of DORA token amount from `20` into `5` in Vota Operator Manual.
+- Fix: Fix `--gas-prices` and `--gas-adjustment` values for commands in Vota Dev Guide.
+
+## [0.1.0-beta.1][0.1.0-beta.1] · 2023-09-24
 
 ### Added
 
@@ -19,7 +46,7 @@
 
 ### Fixed
 
-- Fix: Change Node.js version from `18+` into `18.x`.
+- Fix: Change Node.js version from `18+` into `18.x` in Vota Operator Manual.
 - Fix: Attach `alt` attribution onto the image in Deploy MACI button for better a11y.
 
 ## [0.1.0-beta][0.1.0-beta] · 2023-09-21
@@ -61,12 +88,13 @@
 - Feat: Adaptive favicon and Apple touch icon.
 - Feat: Dynamic page title, description, and Open Graph metadata.
 - Feat: Auto-generated OG images for each page, based on `@vercel/og` with Vercel Edge Functions.
-- Doc: [Read Me](README.md).
-- Doc: [Changelog](CHANGELOG.md).
-- Doc: [MIT License](LICENSE).
-- Doc: [Code of Conduct](CODE_OF_CONDUCT.md), based on [Contributor Covenant](https://www.contributor-covenant.org) v2.1.
+- Docs: [Read Me](README.md).
+- Docs: [Changelog](CHANGELOG.md).
+- Docs: [MIT License](LICENSE).
+- Docs: [Code of Conduct](CODE_OF_CONDUCT.md), based on [Contributor Covenant](https://www.contributor-covenant.org) v2.1.
 - Chore: Configure GitHub [Dependabot](.github/dependabot.yml).
 
+[0.1.0-beta.2]: https://github.com/DoraFactory/df-docs/compare/0.1.0-beta.1...0.1.0-beta.2
 [0.1.0-beta.1]: https://github.com/DoraFactory/df-docs/compare/0.1.0-beta...0.1.0-beta.1
 [0.1.0-beta]: https://github.com/DoraFactory/df-docs/compare/0.1.0-alpha...0.1.0-beta
 [0.1.0-alpha]: https://github.com/DoraFactory/df-docs/compare/eacf593...0.1.0-alpha

README.md

@@ -5,8 +5,8 @@
 
 ## Links
 
-- Production (`main`)：<https://docs.dorafactory.org>
-- Preview (`develop`)：<https://df-docs.vercel.app>
+- Stable (`main`)：<https://docs.dorafactory.org>
+- Canary Preview (`develop`)：<https://df-docs.vercel.app>
 
 ## Conventions
 
@@ -62,19 +62,10 @@ pnpm prettier
 
 The Open Graph image generation API [`/api/og`](pages/api/og.tsx), which uses [`@vercel/og`](https://vercel.com/docs/functions/edge-functions/og-image-generation) library, is dependent on [Vercel Edge Functions](https://vercel.com/docs/functions/edge-functions).
 
-### Production
+### Stable
 
-The production branch is [`main`](https://github.com/github/renaming).
+The [Stable](https://docs.dorafactory.org) version of the documentation corresponds to the [`main`](https://github.com/DoraFactory/df-docs/tree/main) branch.
 
-### Preview
+### Canary Preview
 
-The preview site is deployed by [Vercel](https://vercel.com/).
-
-- Default preview branch: `develop`
-- Preview link: <https://df-docs.vercel.app>
-
-### Preview per commit/branch
-
-Vercel will automatically deploy every latest commit, and assign a unique preview URL.
-
-The same applies for every branch (`df-docs-git-[branch-name]-realfish.vercel.app`). As for the latest preview of a specific branch, e.g., `feature/landing-page`, the URL is <https://df-docs-git-feature-landing-page-realfish.vercel.app>.
+The [Canary Preview](https://df-docs.vercel.app) version corresponds to the [`develop`](https://github.com/DoraFactory/df-docs/tree/develop) branch, which is deployed via [Vercel](https://vercel.com/).

next.config.js

@@ -12,10 +12,6 @@ module.exports = withNextra({
   reactStrictMode: true, // Recommended for the `pages` directory, default in `app`.
   output: 'standalone',
 
-  env: {
-    SITE_ROOT: process.env.SITE_ROOT
-  },
-
   webpack(config) {
     // Config for SVGR
     // const allowedSvgRegex = /\.svg$/i

package.json

@@ -1,6 +1,6 @@
 {
   "name": "df-docs",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.2",
   "private": true,
   "scripts": {
     "build": "next build",
@@ -12,23 +12,23 @@
   },
   "dependencies": {
     "@vercel/og": "^0.5.17",
-    "next": "^13.5.2",
-    "nextra": "^2.13.0",
-    "nextra-theme-docs": "^2.13.0",
+    "next": "^13.5.4",
+    "nextra": "^2.13.1",
+    "nextra-theme-docs": "^2.13.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
     "@svgr/webpack": "^8.1.0",
-    "@types/node": "20.6.4",
-    "@types/react": "^18.2.22",
+    "@types/node": "20.8.2",
+    "@types/react": "^18.2.24",
     "autoprefixer": "^10.4.16",
     "eslint": "8.50.0",
-    "eslint-config-next": "13.5.2",
-    "postcss": "^8.4.30",
+    "eslint-config-next": "13.5.4",
+    "postcss": "^8.4.31",
     "prettier": "3.0.3",
     "prettier-plugin-pkg": "0.18.0",
-    "prettier-plugin-tailwindcss": "0.5.4",
+    "prettier-plugin-tailwindcss": "0.5.5",
     "sass": "^1.68.0",
     "tailwindcss": "^3.3.3",
     "typescript": "5.2.2"

pages/docs/index.mdx

@@ -41,8 +41,10 @@ export const CARD_COPY = [
     <Cards.Card key={i} image arrow title={card.title} href={card.url}>
       <>
         <img
+          with="1200"
+          height="628"
           alt={card.title}
-          src={`${process.env.SITE_ROOT}/api/og?title=${card.title}&desc=${card.desc}`}
+          src={`${process.env.NEXT_PUBLIC_SITE_ROOT}/api/og?title=${card.title}&desc=${card.desc}`}
         />
       </>
     </Cards.Card>

pages/docs/vota-dev/cosmwasm.mdx

@@ -209,7 +209,7 @@ In this example, we will demonstrate how to store on the Mainnet:
 
 ```ansi filename="Terminal"
 $ cd artifacts
-$ dorad tx wasm store counter.wasm  --from <unsafe-test-key-name> --chain-id=<chain-id> --gas-prices 0.1uDORA --gas auto --gas-adjustment 1.3 -b block -y
+$ dorad tx wasm store counter.wasm  --from <unsafe-test-key-name> --chain-id=<chain-id> --gas-prices 100000000000peaka --gas auto --gas-adjustment 1.5 -b block -y
 ```
 
 - `<unsafe-test-key-name>`: Replace it with the key name from your local keys.
@@ -220,7 +220,7 @@ You will find a `CODE_ID` from the output of the command above. Save it as a loc
 Instead, you can also run the following command to set the `CODE_ID` as a variable:
 
 ```ansi filename="Terminal"
-$ TX=$(dorad tx wasm store counter.wasm  --from <unsafe-test-key-name> --chain-id=<chain-id> --gas-prices 0.1uDORA --gas auto --gas-adjustment 1.3 -b block --output json -y | jq -r '.txhash')
+$ TX=$(dorad tx wasm store counter.wasm  --from <unsafe-test-key-name> --chain-id=<chain-id> --gas-prices 100000000000peaka --gas auto --gas-adjustment 1.5 -b block --output json -y | jq -r '.txhash')
 $ CODE_ID=$(dorad query tx $TX --output json | jq -r '.logs[0].events[-1].attributes[0].value')
 $ echo "Your contract code_id is $CODE_ID"
 ```
@@ -248,14 +248,14 @@ $ CONTRACT_ADDR=$(dorad query wasm list-contract-by-code ${CODE_ID} --node https
 
 ```ansi filename="Terminal"
 $ INCREMENT_MSG='{"increment":{}}'
-$ dorad tx wasm execute $CONTRACT_ADDR "$INCREMENT_MSG" --from test1 --gas-prices 0.01uDORA --gas auto --gas-adjustment 1.3 --chain-id "doravota-devnet" --node https://vota-rpc.dorafactory.org:443 -y
+$ dorad tx wasm execute $CONTRACT_ADDR "$INCREMENT_MSG" --from test1 --gas-prices 100000000000peaka --gas auto --gas-adjustment 1.5 --chain-id "doravota-devnet" --node https://vota-rpc.dorafactory.org:443 -y
 ```
 
 ### Reset the count in contract
 
 ```ansi filename="Terminal"
 $ RESET_MSG='{"reset":{"count":0}}'
-$ dorad tx wasm execute $CONTRACT_ADDR "$RESET_MSG" --from test1  --gas-prices 0.01uDORA --gas auto --gas-adjustment 1.3 --chain-id "doravota-devnet" --node https://vota-rpc.dorafactory.org:443 -y
+$ dorad tx wasm execute $CONTRACT_ADDR "$RESET_MSG" --from test1 --gas-prices 100000000000peaka --gas auto --gas-adjustment 1.5 --chain-id "doravota-devnet" --node https://vota-rpc.dorafactory.org:443 -y
 ```
 
 ## Query the contract

pages/docs/vota-dev/dorad.mdx

@@ -131,7 +131,7 @@ The denom of Dora Vota is `peaka`, and `1 DORA = 10^18 peaka`.
 Here is an example of token transfer on Dora Vota:
 
 ```ansi filename="Terminal"
-$ dorad tx bank send <from_addr> <to_addr> <amount> --chain-id vota-ash --gas-prices=0.01peaka --gas=auto --gas-adjustment=1.3 --node https://vota-rpc.dorafactory.org:443
+$ dorad tx bank send <from_addr> <to_addr> <amount> --chain-id vota-ash --gas-prices=100000000000peaka --gas=auto --gas-adjustment=1.5 --node https://vota-rpc.dorafactory.org:443
 ```
 
 ### Query the balance of account

pages/docs/vota/prerequisites.mdx

@@ -13,7 +13,7 @@ For optimal performance and security, it is recommended to prepare an environmen
 
 - **Stable internet**: Ensure reliable connectivity.
 - **Secure computing platform**: Maintain a safe and robust computer environment.
-- **UNIX-like OS with a terminal app/emulator**: macOS, Linux, or simimar systems are recommended for better compatibility with Node.js and CLI operations.
+- **UNIX-like OS with a terminal app/emulator**: macOS, Linux, or similar systems are recommended for better compatibility with Node.js and CLI operations.
 
 ## Install Node.js 18.x version
 
@@ -46,7 +46,7 @@ To facilitate safe and seamless operations, you can set up your wallet by follow
 
 ### Sufficient DORA tokens
 
-- Get sufficient DORA tokens for gas fees, which will be consumed in the operation process. To start with, we recommend you prepare 20 DORA.
+- Get sufficient DORA tokens for gas fees, which will be consumed in the operation process. To start with, we recommend you prepare 5 DORA.
 - You can buy DORA tokens from [[Some CEX/DEX]](https://example.com). Please keep in mind that you should acquire DORA tokens on the **Dora Vota Mainnet**.
 
 </Steps>