Documentation - Edit The Image Of Connect Your Wallet
Introduction
As part of our ongoing efforts to improve the user experience and provide clear instructions, we need to update the image of "Connect your wallet" in our documentation. This change will help users better understand the process of connecting their wallets and ensure a seamless experience. In this article, we will outline the proposed actions, required guidelines, and provide a checklist for resolving this issue.
Description
The current image of "Connect your wallet" is located at https://docs.starknet.id/core/features/registration. However, we have a new image that we would like to use instead. The new image is available at https://github.com/user-attachments/assets/02a08a1f-75f0-4bae-b336-9c0bfd1f0f39.
Proposed Actions
To resolve this issue, please follow these steps:
1. Fork and Create Branch
Fork the repository and create a new branch using the issue number:
git checkout -b fix-[issue-number]
2. Implement Changes
Insert the code snippet if needed with a markdown todo list:
- [ ] Replace the current image with the new one
- [ ] Update the documentation to reflect the change
3. Run Tests and Commit Changes
Make sure your changes don't break existing functionality and commit with a clear message:
git commit -m "Fix: [Short description of the fix]"
Required
To keep our workflow smooth, please make sure you follow these guidelines:
Assignment
Don't create a pull request if you weren’t assigned to this issue.
Timeframe
Complete the task within 3 business days.
Closing the Issue
In your PR description, close the issue by writing Close #[issue_id]
.
Review Process
Once you've submitted your PR, change the label to "ready for review". If changes are requested, address them and then update the label back to "ready for review" once done.
Testing
Test your PR locally before pushing, and verify that tests and build are working after pushing.
Warning
⚠️ WARNING: Failure to follow the requirements above may result in being added to the OnlyDust blacklist, affecting your ability to receive future rewards.
Conclusion
Introduction
As part of our ongoing efforts to improve the user experience and provide clear instructions, we need to update the image of "Connect your wallet" in our documentation. In this Q&A article, we will address some common questions and concerns related to this issue.
Q: What is the current image of "Connect your wallet" used for?
A: The current image of "Connect your wallet" is used in our documentation to illustrate the process of connecting a wallet. However, we have a new image that we would like to use instead to provide a clearer and more accurate representation of the process.
Q: Why do we need to update the image of "Connect your wallet"?
A: We need to update the image of "Connect your wallet" to ensure that our documentation accurately reflects the current process of connecting a wallet. This will help users better understand the process and reduce any confusion that may arise from using an outdated image.
Q: What are the benefits of updating the image of "Connect your wallet"?
A: The benefits of updating the image of "Connect your wallet" include:
- Improved user experience: The new image will provide a clearer and more accurate representation of the process, making it easier for users to understand and follow.
- Reduced confusion: By using an updated image, we can reduce any confusion that may arise from using an outdated image.
- Enhanced credibility: Updating the image of "Connect your wallet" demonstrates our commitment to providing accurate and up-to-date information to our users.
Q: What is the new image of "Connect your wallet" used for?
A: The new image of "Connect your wallet" is used in our documentation to illustrate the process of connecting a wallet. The new image is available at https://github.com/user-attachments/assets/02a08a1f-75f0-4bae-b336-9c0bfd1f0f39.
Q: How do I update the image of "Connect your wallet"?
A: To update the image of "Connect your wallet", please follow these steps:
- Fork the repository and create a new branch using the issue number.
- Implement the changes by replacing the current image with the new one and updating the documentation to reflect the change.
- Run tests and commit the changes with a clear message.
- Follow the required guidelines, including completing the task within 3 business days and closing the issue in the PR description.
Q: What are the required guidelines for updating the image of "Connect your wallet"?
A: The required guidelines for updating the image of "Connect your wallet" include:
- Assignment: Don't create a pull request if you weren’t assigned to this issue.
- Timeframe: Complete the task within 3 business days.
- Closing the Issue: In your PR description, close the issue by writing
Close #[issue_id]
. - Review Process: Once you've submitted your PR, change the label to "ready for review". If changes are requested, address them and then update the label back to "ready for review" once done.
- Testing: Test your PR locally before pushing, and verify that tests and build are working after pushing.
Q: What happens if I fail to follow the required guidelines?
A: ⚠️ WARNING: Failure to follow the requirements above may result in being added to the OnlyDust blacklist, affecting your ability to receive future rewards.
Conclusion
Updating the image of "Connect your wallet" is an essential step in improving the user experience and ensuring a seamless experience for our users. By following the proposed actions and required guidelines, we can resolve this issue efficiently and effectively. If you have any further questions or concerns, please don't hesitate to reach out.