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

Balance component update GIF and description update #20

Closed
metalboyrick opened this issue Oct 3, 2024 · 5 comments · Fixed by #29
Closed

Balance component update GIF and description update #20

metalboyrick opened this issue Oct 3, 2024 · 5 comments · Fixed by #29
Assignees
Labels
documentation Improvements or additions to documentation ODHack8

Comments

@metalboyrick
Copy link
Collaborator

Issue Overview

The Balance Page is outdated. The current balance shows both ETH and STRK balances. Need update on this page and its descriptions

Proposed Solutions or Ideas

  • Your documentation should be clear and concise.
  • Use images where appropriate
  • Use proper styling and hierarchy for text
  • Use proper styling for code and variable names.
  • Use proper callouts when required

Refer to docusaurus for more info: https://docusaurus.io/

@metalboyrick metalboyrick added documentation Improvements or additions to documentation ODHack8 labels Oct 3, 2024
@ShantelPeters
Copy link

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am frontend developer and also skilled in technical documetation.i have a good understanding with technologies like Html, css, javascript, typescript , cario . i have also successfully contributed to open source projects like arkproject, stark Quest, shinigami.

How I plan on tackling this issue

I will approach the problem by
Updating the balance page by separating ETH and STRK balances, use clear headings and concise descriptions, then add visuals like icons or charts, style code properly, and use Docusaurus callouts for key info.

@0xdevcollins
Copy link
Contributor

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

My name is Collins Ikechukwu. I'm a full stack blockchain developer developer.

How I plan on tackling this issue

I will update the documentation for the Balance Page to reflect the current balances of both ETH and STRK accurately. The revised documentation will include a clear and concise description of the Balance Page, detailing how the balances are displayed and any relevant features or functionalities.

I will incorporate images to visually represent the updated Balance Page, helping users understand the layout and changes. The documentation will be structured with proper styling and hierarchy for text to enhance readability and ease of navigation.

For any code snippets or variable names, I will apply appropriate styling to ensure they stand out from regular text. Additionally, I will use callouts to emphasize key information, tips, or best practices regarding the Balance Page.

To ensure a polished presentation, I will refer to Docusaurus for guidance on documentation layout and design elements. After making the updates, I will review the documentation for accuracy and clarity before finalizing it.

@Benjtalkshow
Copy link
Contributor

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I’m Benjamin, and I’m willing to work on updating the Balance Page for this amazing project, ensuring it reflects the current features and provides a clear overview for users. Since joining OnlyDust, I’ve made 20 contributions, and I’m confident in my documentation and frontend development skills. I believe I can make this page visually appealing and informative.

How I plan on tackling this issue

The goal is to update the Balance Page to correctly show ETH and STRK balances and provide accurate descriptions for both.

Here’s what I plan to do:

  • I will update the UI to ensure accurate and clear display of both ETH and STRK balances.
  • I will add a GIF or image that visually demonstrates how the balance component works in real time.
  • I will rewrite descriptions to provide better clarity on what each balance represents.
  • I will use proper text hierarchy, styling for code, and variable names to make the documentation cleaner and more professional.
  • I will also ensure to add callouts for important notes or tips where necessary to guide users.
    I will ensure the updated content adheres to the latest design guidelines. To help with the layout and design:

Once the update is complete, I’ll review the entire page to make sure it’s clear, engaging, and user-friendly. Then, I will make a PR.

@Nadai2010
Copy link
Collaborator

Hello, since @ShantelPeters already has an open issue, we will assign it to @devcollinss in order of preference.

@metalboyrick
Copy link
Collaborator Author

Hi @devcollinss , sorry for rushing in but we would like to remind you that ODHack8 is almost finished :( would encourage to start working on this issue and put out a PR ASAP, thanks in advance!

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

Successfully merging a pull request may close this issue.

5 participants