Initial commit

wriches · May 3, 2023 · c8beb3f · c8beb3f
commit c8beb3f
Show file tree

Hide file tree

Showing 91 changed files with 13,888 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,4 @@
+{
+  "tabWidth": 2,
+  "useTabs": false
+}
diff --git a/README.md b/README.md
@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/babel.config.js b/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/docs/build/create-smart-contracts/build-and-test.md b/docs/build/create-smart-contracts/build-and-test.md
@@ -0,0 +1,4 @@
+---
+title: Build and Test Move Packages
+slug: /build-and-test
+---
diff --git a/docs/build/create-smart-contracts/custom-upgrade-policies.md b/docs/build/create-smart-contracts/custom-upgrade-policies.md
@@ -0,0 +1,4 @@
+---
+title: Custom Upgrade Policies
+slug: /custom-upgrade-policies
+---
diff --git a/docs/build/create-smart-contracts/debug-and-publish.md b/docs/build/create-smart-contracts/debug-and-publish.md
@@ -0,0 +1,4 @@
+---
+title: Debug and Publish Move Packages
+slug: /debug-and-publish
+---
diff --git a/docs/build/create-smart-contracts/move-lock.md b/docs/build/create-smart-contracts/move-lock.md
@@ -0,0 +1,4 @@
+---
+title: Move.lock File
+slug: /move-lock
+---
diff --git a/docs/build/create-smart-contracts/move-toml.md b/docs/build/create-smart-contracts/move-toml.md
@@ -0,0 +1,4 @@
+---
+title: Move.toml File
+slug: /move-toml
+---
diff --git a/docs/build/create-smart-contracts/sui-move-library.md b/docs/build/create-smart-contracts/sui-move-library.md
@@ -0,0 +1,4 @@
+---
+title: Sui Move Library
+slug: /sui-move-library
+---
diff --git a/docs/build/create-smart-contracts/time.md b/docs/build/create-smart-contracts/time.md
@@ -0,0 +1,4 @@
+---
+title: Accessing Time in Sui Move
+slug: /time
+---
diff --git a/docs/build/create-smart-contracts/upgrade-packages.md b/docs/build/create-smart-contracts/upgrade-packages.md
@@ -0,0 +1,4 @@
+---
+title: Upgrade Move Packages
+slug: /upgrade-packages
+---
diff --git a/docs/build/create-smart-contracts/write-move-packages.md b/docs/build/create-smart-contracts/write-move-packages.md
@@ -0,0 +1,4 @@
+---
+title: Write Move Packages
+slug: /write-move-packages
+---
diff --git a/docs/build/interact-with-sui/event-query-and-subscription.md b/docs/build/interact-with-sui/event-query-and-subscription.md
@@ -0,0 +1,4 @@
+---
+title: Event Query and Subscription
+slug: /event-query-and-subscription
+---
diff --git a/docs/build/interact-with-sui/json-rpc-api.md b/docs/build/interact-with-sui/json-rpc-api.md
@@ -0,0 +1,4 @@
+---
+title: JSON-RPC API
+slug: /json-rpc-api
+---
diff --git a/docs/build/interact-with-sui/programmable-tx-blocks.md b/docs/build/interact-with-sui/programmable-tx-blocks.md
@@ -0,0 +1,4 @@
+---
+title: Programmable Transaction Blocks with TypeScript SDK
+slug: /programmable-tx-blocks
+---
diff --git a/docs/build/interact-with-sui/rust-sdk.md b/docs/build/interact-with-sui/rust-sdk.md
@@ -0,0 +1,4 @@
+---
+title: Rust SDK
+slug: /rust-sdk
+---
diff --git a/docs/build/interact-with-sui/ts-js-sdk.md b/docs/build/interact-with-sui/ts-js-sdk.md
@@ -0,0 +1,4 @@
+---
+title: TypeScript / JavaScript SDK
+slug: /ts-js-sdk
+---
diff --git a/docs/build/program-with-objects/build-and-test.md b/docs/build/program-with-objects/build-and-test.md
@@ -0,0 +1,4 @@
+---
+title: Build and Test Move Packages
+slug: /build-and-test
+---
diff --git a/docs/build/program-with-objects/debug-and-publish.md b/docs/build/program-with-objects/debug-and-publish.md
@@ -0,0 +1,4 @@
+---
+title: Debug and Publish Move Packages
+slug: /debug-and-publish
+---
diff --git a/docs/build/program-with-objects/immutable-objects.md b/docs/build/program-with-objects/immutable-objects.md
@@ -0,0 +1,4 @@
+---
+title: Immutable Objects
+slug: /immutable-objects
+---
diff --git a/docs/build/program-with-objects/object-basics.md b/docs/build/program-with-objects/object-basics.md
@@ -0,0 +1,4 @@
+---
+title: Object Basics
+slug: /object-basics
+---
diff --git a/docs/build/program-with-objects/using-objects.md b/docs/build/program-with-objects/using-objects.md
@@ -0,0 +1,4 @@
+---
+title: Using Objects
+slug: /using-objects
+---
diff --git a/docs/build/program-with-objects/write-move-packages.md b/docs/build/program-with-objects/write-move-packages.md
@@ -0,0 +1,4 @@
+---
+title: Write Move Packages
+slug: /write-move-packages
+---
diff --git a/docs/build/setup/client-cli.md b/docs/build/setup/client-cli.md
@@ -0,0 +1,4 @@
+---
+title: Sui Client CLI
+slug: /client-cli
+---
diff --git a/docs/build/setup/connect-to-a-network.md b/docs/build/setup/connect-to-a-network.md
@@ -0,0 +1,4 @@
+---
+title: Connect to a Sui Network
+slug: /connect-to-a-network
+---
diff --git a/docs/build/setup/faucet.md b/docs/build/setup/faucet.md
@@ -0,0 +1,4 @@
+---
+title: Sui Faucet
+slug: /faucet
+---
diff --git a/docs/build/setup/gas-changes.md b/docs/build/setup/gas-changes.md
@@ -0,0 +1,4 @@
+---
+title: Sui Gas Changes
+slug: /gas-changes
+---
diff --git a/docs/build/setup/install-sui.md b/docs/build/setup/install-sui.md
@@ -0,0 +1,4 @@
+---
+title: Install Sui
+slug: /install-sui
+---
diff --git a/docs/build/setup/local-network.md b/docs/build/setup/local-network.md
@@ -0,0 +1,4 @@
+---
+title: Sui Local Network
+slug: /local-network
+---
diff --git a/docs/build/setup/object-display-standard.md b/docs/build/setup/object-display-standard.md
@@ -0,0 +1,4 @@
+---
+title: Sui Object Display Standard
+slug: /object-display-standard
+---
diff --git a/docs/contribute/code-of-conduct.md b/docs/contribute/code-of-conduct.md
@@ -0,0 +1,4 @@
+---
+title: Code of Conduct
+slug: /code-of-conduct
+---
diff --git a/docs/contribute/contribute-to-sui-repos.md b/docs/contribute/contribute-to-sui-repos.md
@@ -0,0 +1,4 @@
+---
+title: Contribute to Sui Repositories
+slug: /contribute-to-sui-repos
+---
diff --git a/docs/contribute/improve-documentation.md b/docs/contribute/improve-documentation.md
@@ -0,0 +1,4 @@
+---
+title: Improve Documentation
+slug: /improve-documentation
+---
diff --git a/docs/contribute/localize-sui-docs.md b/docs/contribute/localize-sui-docs.md
@@ -0,0 +1,4 @@
+---
+title: Localize Sui Documentation
+slug: /localize-sui-docs
+---
diff --git a/docs/contribute/run-fullnode.md b/docs/contribute/run-fullnode.md
@@ -0,0 +1,4 @@
+---
+title: Run a Full Node
+slug: /run-fullnode
+---
diff --git a/docs/contribute/run-validator.md b/docs/contribute/run-validator.md
@@ -0,0 +1,4 @@
+---
+title: Run a Validator
+slug: /run-validator
+---
diff --git a/docs/contribute/submit-a-sip.md b/docs/contribute/submit-a-sip.md
@@ -0,0 +1,4 @@
+---
+title: Submit a SIP
+slug: /submit-a-sip
+---
diff --git a/docs/learn/about-sui/how-sui-move-differs.md b/docs/learn/about-sui/how-sui-move-differs.md
@@ -0,0 +1,4 @@
+---
+title: How Sui Move Differs From Core Move
+slug: /how-sui-move-differs
+---
diff --git a/docs/learn/about-sui/sui-glossary.md b/docs/learn/about-sui/sui-glossary.md
@@ -0,0 +1,4 @@
+---
+title: Sui Glossary
+slug: /sui-glossary
+---
diff --git a/docs/learn/about-sui/sui-security.md b/docs/learn/about-sui/sui-security.md
@@ -0,0 +1,4 @@
+---
+title: Sui Security
+slug: /sui-security
+---
diff --git a/docs/learn/about-sui/why-move.md b/docs/learn/about-sui/why-move.md
@@ -0,0 +1,4 @@
+---
+title: Why Move?
+slug: /why-move
+---
diff --git a/docs/learn/cryptography/intent-signing.md b/docs/learn/cryptography/intent-signing.md
@@ -0,0 +1,4 @@
+---
+title: Sui Intent Signing
+slug: /intent-signing
+---
diff --git a/docs/learn/cryptography/keys-and-addresses.md b/docs/learn/cryptography/keys-and-addresses.md
@@ -0,0 +1,4 @@
+---
+title: Sui Keys and Addresses
+slug: /keys-and-addresses
+---
diff --git a/docs/learn/cryptography/multisig.md b/docs/learn/cryptography/multisig.md
@@ -0,0 +1,4 @@
+---
+title: Sui Multisig
+slug: /multisig
+---
diff --git a/docs/learn/cryptography/offline-signing.md b/docs/learn/cryptography/offline-signing.md
@@ -0,0 +1,4 @@
+---
+title: Sui Offline Signing
+slug: /offline-signing
+---
diff --git a/docs/learn/economics/gas-in-sui.md b/docs/learn/economics/gas-in-sui.md
@@ -0,0 +1,4 @@
+---
+title: Gas in Sui
+slug: /gas
+---
diff --git a/docs/learn/economics/gas-pricing.md b/docs/learn/economics/gas-pricing.md
@@ -0,0 +1,4 @@
+---
+title: Sui Gas Pricing
+slug: /gas-pricing
+---
diff --git a/docs/learn/economics/proof-of-stake.md b/docs/learn/economics/proof-of-stake.md
@@ -0,0 +1,4 @@
+---
+title: Proof-of-Stake
+slug: /proof-of-stake
+---
diff --git a/docs/learn/economics/sui-storage-fund.md b/docs/learn/economics/sui-storage-fund.md
@@ -0,0 +1,4 @@
+---
+title: Sui Storage Fund
+slug: /storage-fund
+---
diff --git a/docs/learn/economics/sui-token.md b/docs/learn/economics/sui-token.md
@@ -0,0 +1,4 @@
+---
+title: Sui Token
+slug: /sui-token
+---
diff --git a/docs/learn/economics/tokenomics-whitepaper.md b/docs/learn/economics/tokenomics-whitepaper.md
@@ -0,0 +1,4 @@
+---
+title: Tokenomics Whitepaper
+slug: /tokenomics-whitepaper
+---
diff --git a/docs/learn/how-sui-works/consensus-engine.md b/docs/learn/how-sui-works/consensus-engine.md
@@ -0,0 +1,4 @@
+---
+title: Consensus Engine
+slug: /consensus-engine
+---
diff --git a/docs/learn/how-sui-works/object-and-package-versioning.md b/docs/learn/how-sui-works/object-and-package-versioning.md
@@ -0,0 +1,4 @@
+---
+title: Object and Package Versioning
+slug: /object-package-versioning
+---
diff --git a/docs/learn/how-sui-works/objects.md b/docs/learn/how-sui-works/objects.md
@@ -0,0 +1,4 @@
+---
+title: Objects
+slug: /objects
+---
diff --git a/docs/learn/how-sui-works/single-writer-apps.md b/docs/learn/how-sui-works/single-writer-apps.md
@@ -0,0 +1,4 @@
+---
+title: Single-Writer Apps
+slug: /single-writer-apps
+---
diff --git a/docs/learn/how-sui-works/sponsored-transactions.md b/docs/learn/how-sui-works/sponsored-transactions.md
@@ -0,0 +1,4 @@
+---
+title: Sponsored Transactions
+slug: /sponsored-transactions
+---
diff --git a/docs/learn/how-sui-works/sui-compared.md b/docs/learn/how-sui-works/sui-compared.md
@@ -0,0 +1,4 @@
+---
+title: Sui Compared to Other Blockchains
+slug: /sui-comparison
+---
diff --git a/docs/learn/how-sui-works/transactions.md b/docs/learn/how-sui-works/transactions.md
@@ -0,0 +1,4 @@
+---
+title: Transactions
+slug: /transactions
+---
diff --git a/docs/learn/how-sui-works/validators.md b/docs/learn/how-sui-works/validators.md
@@ -0,0 +1,4 @@
+---
+title: Validators
+slug: /about-validators
+---
diff --git a/docs/learn/nodes/database-snapshots.md b/docs/learn/nodes/database-snapshots.md
@@ -0,0 +1,4 @@
+---
+title: Database Snapshots
+slug: /database-snapshots
+---
diff --git a/docs/learn/nodes/full-node.md b/docs/learn/nodes/full-node.md
@@ -0,0 +1,4 @@
+---
+title: Sui Full Node
+slug: /full-node
+---
diff --git a/docs/learn/nodes/logging.md b/docs/learn/nodes/logging.md
@@ -0,0 +1,4 @@
+---
+title: Logging
+slug: /logging
+---
diff --git a/docs/learn/nodes/validator.md b/docs/learn/nodes/validator.md
@@ -0,0 +1,4 @@
+---
+title: Sui Validator
+slug: /run-a-validator
+---
diff --git a/docs/learn/sui-move/about.md b/docs/learn/sui-move/about.md
@@ -0,0 +1,5 @@
+---
+title: About Sui Move
+sidebar_label: About
+slug: /about-sui-move
+---
diff --git a/docs/learn/sui-move/the-move-book.md b/docs/learn/sui-move/the-move-book.md
@@ -0,0 +1,4 @@
+---
+title: The Move Book
+slug: /move-book
+---
diff --git a/docs/reference/examples.md b/docs/reference/examples.md
@@ -0,0 +1,4 @@
+---
+title: Examples
+slug: /examples
+---
diff --git a/docs/reference/exchange-integration-guide.md b/docs/reference/exchange-integration-guide.md
@@ -0,0 +1,4 @@
+---
+title: Sui Exchange Integration Guide
+slug: /exchange-integration-guide
+---
diff --git a/docs/reference/sui-framework-reference.md b/docs/reference/sui-framework-reference.md
@@ -0,0 +1,4 @@
+---
+title: Sui Framework Reference
+slug: /sui-framework-reference
+---