From 1e214bd3e653dff30accf8bf37ab1fd7b75410a2 Mon Sep 17 00:00:00 2001 From: metalboyrick Date: Wed, 8 Jan 2025 21:25:07 +0700 Subject: [PATCH 1/3] fix: polishing deploy production documentation --- docs/deploying/deploy-production.mdx | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/deploying/deploy-production.mdx b/docs/deploying/deploy-production.mdx index 231254f..c8698c5 100644 --- a/docs/deploying/deploy-production.mdx +++ b/docs/deploying/deploy-production.mdx @@ -13,10 +13,10 @@ Before deploying to production, ensure you have the correct versions of all depe ```bash # Check versions -node --version # >= v18.17 -starknet-devnet --version # 0.2.3 -scarb --version # 2.9.2 -snforge --version # 0.34.0 +node --version # >= v18.17 +starknet-devnet --version # 0.2.3 +scarb --version # 2.9.2 +snforge --version # 0.34.0 ``` :::warning @@ -35,7 +35,9 @@ Delete the debug page and its components: rm -rf packages/nextjs/app/debug ``` -#### 2. Remove the debug route from your navigation if you've added it manually in any of your components. +#### 2. Remove the debug route from your navigation + +If you've added it manually in any of your components, you can remove the debug route from it. :::tip Hint If you want to keep the debug features for development while removing them from production, you can use environment-based conditional rendering: @@ -106,13 +108,14 @@ eslint: { These settings control how your application handles TypeScript and ESLint errors during the build process: -- When NEXT_PUBLIC_IGNORE_BUILD_ERROR is set to "true": +- When `NEXT_PUBLIC_IGNORE_BUILD_ERROR` environment variable is set to `true`: - TypeScript type checking errors won't stop your build - ESLint warnings and errors won't prevent deployment - This is useful when: - You're in rapid development and want to test deployments despite minor type issues - You're dealing with third-party dependencies that have type conflicts - You're migrating a JavaScript project to TypeScript and want to deploy while still fixing type issues - :::warning - While these settings can help you deploy quickly, it's recommended to fix all TypeScript and ESLint errors before deploying to production. Ignoring these errors might hide potential bugs or issues in your code. - :::warning + +:::warning +While these settings can help you deploy quickly, it's recommended to fix all TypeScript and ESLint errors before deploying to production. Ignoring these errors might hide potential bugs or issues in your code. +:::warning #### 2. Webpack optimization for compatibility: @@ -227,7 +230,7 @@ const nextConfig = { ## 6. Production Deployment Checklist -Before deploying to production, ensure you have: +Before deploying to production, you can follow the following checklist to make sure you have the most optimum build: - [ ] Removed or conditionally rendered debug packages - [ ] Configured production environment variables From a4553d7210b01e2f20d9fd04975b357a0ff5e7ee Mon Sep 17 00:00:00 2001 From: metalboyrick Date: Wed, 8 Jan 2025 21:29:09 +0700 Subject: [PATCH 2/3] fix: eth stark titles --- docs/eth-stark/eth-stark.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/eth-stark/eth-stark.md b/docs/eth-stark/eth-stark.md index c8b1947..3a35baa 100644 --- a/docs/eth-stark/eth-stark.md +++ b/docs/eth-stark/eth-stark.md @@ -2,7 +2,7 @@ sidebar_position: 6 --- -# 🚩 (Coming Soon) Using Scaffold Stark with Ethereum Contracts +# 🚩 Using Scaffold Stark with Ethereum Contracts [Scaffold-ETH-Stark](https://github.com/Scaffold-Stark/scaffold-eth-stark) is an innovative toolkit that combines the capabilities of Scaffold-Stark and Scaffold-ETH, providing a unified solution for building decentralized applications (dapps) on both Starknet and EVM-compatible blockchains. From b5b7674edfc7ce24d59bf1129f3a6350fe913147 Mon Sep 17 00:00:00 2001 From: metalboyrick Date: Wed, 8 Jan 2025 21:29:18 +0700 Subject: [PATCH 3/3] ffix: polish starknet devnet asdf --- docs/quick-start/starknet-devnet-with-asdf.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/quick-start/starknet-devnet-with-asdf.mdx b/docs/quick-start/starknet-devnet-with-asdf.mdx index c4a281f..6ce866f 100644 --- a/docs/quick-start/starknet-devnet-with-asdf.mdx +++ b/docs/quick-start/starknet-devnet-with-asdf.mdx @@ -1,6 +1,6 @@ -# Starknet Devnet - Installation with asdf +# Setting up `starknet-devnet` with `asdf` -This document provides a guide to install **Starknet Devnet** using `asdf`, a Rust-based tool for developers. Below, you'll find instructions for installation using `asdf`. +This document provides a guide to install **Starknet Devnet** using `asdf`, a Rust-based tool for developers. Below, you'll find instructions for installation using `asdf`. This method is preferred since it will be easier to stay tune to updates and sync in case there are major changes. ## Requirements