docs: update linking local dependencies guide #1641
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Summary of Changes This update enhances the linking-deps.mdx file in the Fuel Wallet documentation by adding clearer instructions and additional steps for linking local dependencies, specifically for the @fuel-ui and @fuel-ts repositories. Details Detailed Linking Instructions: Added step-by-step guidance for linking @fuel-ui and @fuel-ts packages locally using pnpm. Provided clear examples of commands, such as linking dependencies to the global pnpm store and executing builds to reflect changes in the Fuel Wallet environment. Configuration Edits: Instructed users on editing the scripts/deps.sh file in the fuels-wallet root directory to enable links for @fuel-ui and @fuel-ts by setting LINK_FUEL_UI and LINK_FUEL_TS flags. Running Development Commands: Explained how to start the development server with linked dependencies using pnpm dev, pnpm dev:deps, and pnpm dev:crx commands. Verification and Testing Steps: Added a new "Detailed Verification Steps" section to help users confirm that local dependencies are correctly linked and functioning. Included specific tests: Component Rendering Test: Checks that components from @fuel-ui render correctly. Functionality Test: Verifies that functions from @fuel-ts return expected results. End-to-End (E2E) Test: Confirms that key workflows (e.g., wallet connection) work as expected. Troubleshooting Section: Provided troubleshooting steps for first-time linking and setup issues, including re-running pnpm setup if necessary. Purpose These updates are intended to improve the clarity and usability of the documentation, particularly for contributors setting up local dependencies. The new instructions and testing guidance will help reduce setup issues and ensure contributors have a smoother experience.
Miska05
requested review from
luizstacio,
pedronauck,
LuizAsFight,
helciofranco,
arthurgeron,
rodrigobranas and
nelitow
as code owners
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of Changes
This update enhances the linking-deps.mdx file in the Fuel Wallet documentation by adding clearer instructions and additional steps for linking local dependencies, specifically for the @fuel-ui and @fuel-ts repositories.
Details
Detailed Linking Instructions:
Added step-by-step guidance for linking @fuel-ui and @fuel-ts packages locally using pnpm. Provided clear examples of commands, such as linking dependencies to the global pnpm store and executing builds to reflect changes in the Fuel Wallet environment. Configuration Edits:
Instructed users on editing the scripts/deps.sh file in the fuels-wallet root directory to enable links for @fuel-ui and @fuel-ts by setting LINK_FUEL_UI and LINK_FUEL_TS flags. Running Development Commands:
Explained how to start the development server with linked dependencies using pnpm dev, pnpm dev:deps, and pnpm dev:crx commands. Verification and Testing Steps:
Added a new "Detailed Verification Steps" section to help users confirm that local dependencies are correctly linked and functioning. Included specific tests:
Component Rendering Test: Checks that components from @fuel-ui render correctly. Functionality Test: Verifies that functions from @fuel-ts return expected results. End-to-End (E2E) Test: Confirms that key workflows (e.g., wallet connection) work as expected. Troubleshooting Section:
Provided troubleshooting steps for first-time linking and setup issues, including re-running pnpm setup if necessary. Purpose
These updates are intended to improve the clarity and usability of the documentation, particularly for contributors setting up local dependencies. The new instructions and testing guidance will help reduce setup issues and ensure contributors have a smoother experience.