Merge pull request #14 from Quantum3-Labs/gabi/docs

gianalarcon · web-flow · commit 0578d34848e7 · 2024-08-24T11:02:05.000+08:00
Update footer
diff --git a/docs/components/CustomConnectButton.md b/docs/components/CustomConnectButton.md
@@ -4,7 +4,7 @@ sidebar_position: 7
 
 # CustomConnectButton
 
-Scaffold-Stark 2 uses a custom _"Connect Button"_, that is enhanced with several useful features:
+Scaffold-Stark uses a custom _"Connect Button"_, that is enhanced with several useful features:
 
 - **Balance Display**: Shows the balance of the native token from the connected address.
 - **Chain Name and Color**: Displays the name of the connected blockchain and uses a distinct color for each chain.
diff --git a/docs/components/_category_.json b/docs/components/_category_.json
@@ -4,6 +4,6 @@
   "link": {
     "type": "generated-index",
     "slug": "components",
-    "description": "Scaffold-Stark 2 provides a set of pre-built components for common web3 use cases. You can make use of them to accelerate and simplify your dapp development."
+    "description": "Scaffold-Stark provides a set of pre-built components for common web3 use cases. You can make use of them to accelerate and simplify your dapp development."
   }
 }
diff --git a/docs/contributing/contributing.md b/docs/contributing/contributing.md
@@ -2,9 +2,9 @@
 sidebar_position: 7
 ---
 
-# 🙏 Contributing to Scaffold-Stark 2
+# 🙏 Contributing to Scaffold-Stark
 
-We welcome contributions to Scaffold-Stark 2!
+We welcome contributions to Scaffold-Stark!
 
 This section aims to provide an overview of the contribution workflow to help us make the contribution process effective for everyone involved.
 
diff --git a/docs/hooks/hooks.md b/docs/hooks/hooks.md
@@ -4,9 +4,9 @@ sidebar_position: 4
 
 # 🛠 Interacting with Your Smart Contracts
 
-Scaffold-Stark 2 provides a collection of custom React hooks designed to simplify interactions with your deployed smart contracts. These hooks are wrappers around Starknet-React, an easy-to-use interface with typescript autocompletions for reading from, writing to, and monitoring events emitted by your smart contracts.
+Scaffold-Stark provides a collection of custom React hooks designed to simplify interactions with your deployed smart contracts. These hooks are wrappers around Starknet-React, an easy-to-use interface with typescript autocompletions for reading from, writing to, and monitoring events emitted by your smart contracts.
 
-If you need to interact with external contracts (i.e. not deployed with your SS-2 instance) you can add external contract data to your `packages/nextjs/contracts/preDeployedContracts.ts` file, which would let you use Scaffold-ETH 2 hooks.
+If you need to interact with external contracts (i.e. not deployed with your SS-2 instance) you can add external contract data to your `packages/nextjs/contracts/preDeployedContracts.ts` file, which would let you use Scaffold-Stark hooks.
 
 To achieve this, include the contract name, its `address`, and `abi` in `preDeployedContracts.ts` for each chain ID. Ensure to update the [`targetNetworks`](/deploying/deploy-nextjs-app#--targetnetworks) in `scaffold.config.ts` to your preferred chains to enable hooks typescript autocompletion.
 
diff --git a/docs/intro.md b/docs/intro.md
@@ -3,21 +3,21 @@ sidebar_position: 1
 slug: /
 ---
 
-# 🏗 Welcome to Scaffold-Stark 2
+# 🏗 Welcome to Scaffold-Stark
 
 [Scaffold-Stark](https://github.com/Quantum3-Labs/scaffold-stark-2) is everything you need to get started building decentralized applications on Starknet! 🚀
 
 ⚙️ Built using NextJS, StarknetJS, Scarb, Starknet-React, Starknet Foundry and Typescript.
 
-## About Scaffold-Stark 2
+## About Scaffold-Stark
 
 Scaffold-Stark is an open-source, up-to-date toolkit for building decentralized applications (dapps) on the Starknet blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts. Scaffold-Stark is a UI-agnostic framework, meaning it does not enforce any specific UI framework or library, giving developers the flexibility to choose their preferred UI tools and libraries.
 
 - ✅ **Contract Fast Reload**: Your frontend auto-adapts to your smart contract as you edit it.
 - 🔥 **Burner Wallet & Local Faucet**: Quickly test your application with a burner wallet and local faucet.
 - 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Starknet network.
 
-## Scaffold-Stark2 Tech Stack
+## Scaffold-Stark Tech Stack
 
 Scaffold-Stark is not a product itself but more of a combination or stack of other great tools. It allows you to quickly build and iterate over your smart contracts and frontends.
 
diff --git a/docs/quick-start/customize-your-own-dApp.mdx b/docs/quick-start/customize-your-own-dApp.mdx
@@ -115,6 +115,6 @@ In this example, the `MyBalance` component:
 ### Using Scaffold Stark Hooks
 
 The `hooks` directory, located at `packages/nextjs/hooks/scaffold-stark`, offers several hooks.
-Scaffold-Stark 2 provides a collection of custom React hooks designed to simplify interactions with your deployed smart contracts.
+Scaffold-Stark provides a collection of custom React hooks designed to simplify interactions with your deployed smart contracts.
 These hooks are wrappers around Starknet-React, an easy-to-use interface with TypeScript autocompletions for reading from, writing to, and monitoring events emitted by your smart contracts.
 For more details, please see the [Interacting with Your Smart Contracts](../hooks) section.
diff --git a/docs/quick-start/environment.mdx b/docs/quick-start/environment.mdx
@@ -5,7 +5,7 @@ description: How to set up your development environment for Scaffold Stark-2.
 
 # Environment
 
-Now that our installation is complete, let's configure the development environment for Scaffold Stark-2.
+Now that our installation is complete, let's configure the development environment for Scaffold Stark.
 
 ### 1. **Initialize a Local Blockchain**:
 
diff --git a/docs/quick-start/installation.mdx b/docs/quick-start/installation.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-description: Requirements and installation methods to get started with Scaffold Stark-2.
+description: Requirements and installation methods to get started with Scaffold Stark.
 ---
 
 # Installation
@@ -135,7 +135,7 @@ curl --location 'https://starknet-sepolia.public.blastapi.io/rpc/v0_7' \
 
 ## Setup
 
-To get started with Scaffold-Stark 2, you have two options:
+To get started with Scaffold-Stark, you have two options:
 
 1. Follow readme to clone the repository.
 2. Use the npx command: ` npx create-stark@latest` to bootstrap the project directly.
@@ -152,7 +152,7 @@ yarn install
 
 ### Option 2: Setup using `npx create-stark@latest`
 
-For a simplified setup, Scaffold-Stark 2 offers a beta npx method that guides you interactively through the setup.
+For a simplified setup, Scaffold-Stark offers a beta npx method that guides you interactively through the setup.
 
 Bootstrap the project:
 
diff --git a/docs/recipes/GetCurrentBalanceFromAccount.md b/docs/recipes/GetCurrentBalanceFromAccount.md
@@ -54,7 +54,7 @@ export const ConnectedAddressBalance = () => {
 
 ### Step 2: Retrieve the Connected Account
 
-Fetch the Ethereum address of the currently connected account using the [useAccount starknet-react hook](https://starknet-react.com/hooks/account/useaccount) and easily display them using Scaffold Stark-2 [Address](/components/Address) and [Balance](/components/Balance) components.
+Fetch the Ethereum address of the currently connected account using the [useAccount starknet-react hook](https://starknet-react.com/hooks/account/useaccount) and easily display them using Scaffold Stark [Address](/components/Address) and [Balance](/components/Balance) components.
 
 ```tsx title="components/ConnectedAddressBalance.tsx"
 // highlight-start
diff --git a/docs/recipes/_category_.json b/docs/recipes/_category_.json
@@ -4,6 +4,6 @@
   "link": {
     "type": "generated-index",
     "slug": "recipes",
-    "description": "Explore a collection of practical recipes to implement common web3 use-cases with Scaffold-ETH 2. Learn how to interact with smart contracts, read and display data, manage account balances, and more. Each recipe offers step-by-step guidance, making it easy to implement different blockchain features into your dApps."
+    "description": "Explore a collection of practical recipes to implement common web3 use-cases with Scaffold-Stark. Learn how to interact with smart contracts, read and display data, manage account balances, and more. Each recipe offers step-by-step guidance, making it easy to implement different blockchain features into your dApps."
   }
 }
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -5,8 +5,9 @@ const lightCodeTheme = require("prism-react-renderer/themes/github");
 const darkCodeTheme = require("prism-react-renderer/themes/dracula");
 
 /** @type {import('@docusaurus/types').Config} */
+// @ts-ignore
 const config = {
-  title: "Scaffold-Stark 2 | Docs",
+  title: "Scaffold-Stark | Docs",
   tagline: "Open-source toolkit for building dapps",
   favicon: "img/icon-starknet.svg",
 
@@ -19,7 +20,7 @@ const config = {
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
   organizationName: "scaffold-stark",
-  projectName: "scaffold-Stark-2",
+  projectName: "scaffold-Stark",
 
   scripts: [
     {
@@ -71,18 +72,12 @@ const config = {
       },
       image: "img/icon-starknet.svg",
       navbar: {
-        title: "Scaffold-Stark 2 | Docs",
+        title: "Scaffold-Stark | Docs",
         logo: {
           alt: "scaffold-stark-logo",
           src: "img/logo-starknet.svg",
         },
         items: [
-          // commented until Scaffold-eth 2 website is launched
-          // {
-          //   href: 'https://scaffoldeth.io/',
-          //   label: 'SE-2 Website',
-          //   position: 'left',
-          // },
           {
             href: "https://github.com/Quantum3-Labs/ss2-docs",
             label: "GitHub Docs",
@@ -98,24 +93,11 @@ const config = {
       footer: {
         style: "dark",
         links: [
-          {
-            title: "Built with ♥ at BuidlGuidl",
-            items: [
-              {
-                label: "BuidlGuidl Website",
-                to: "https://buidlguidl.com/",
-              },
-              {
-                label: "BuidlGuidl Twitter",
-                to: "https://twitter.com/buidlguidl",
-              },
-            ],
-          },
           {
             title: "GitHub",
             items: [
               {
-                label: "Scaffold-Stark 2 GitHub",
+                label: "Scaffold-Stark GitHub",
                 href: "https://github.com/Quantum3-Labs/scaffold-stark-2",
               },
               {
@@ -138,7 +120,7 @@ const config = {
             ],
           },
         ],
-        copyright: `Copyright © ${new Date().getFullYear()} Scaffold-stark Docs. Built with Docusaurus.`,
+        copyright: `Copyright © ${new Date().getFullYear()} Scaffold-Stark Docs. Built with Docusaurus.`,
       },
       prism: {
         theme: lightCodeTheme,

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,6 @@`
`4`	`4`	`"link": {`
`5`	`5`	`"type": "generated-index",`
`6`	`6`	`"slug": "components",`
`7`		`- "description": "Scaffold-Stark 2 provides a set of pre-built components for common web3 use cases. You can make use of them to accelerate and simplify your dapp development."`
	`7`	`+ "description": "Scaffold-Stark provides a set of pre-built components for common web3 use cases. You can make use of them to accelerate and simplify your dapp development."`
`8`	`8`	`}`
`9`	`9`	`}`