Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update linking local dependencies guide #1641

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Miska05
Copy link

@Miska05 Miska05 commented Oct 30, 2024

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.

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.
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants