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

update-docs #14

Merged
merged 2 commits into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions docs/CategoryHome.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,71 @@
# Requirements Details

* ### Portfolio
* ### Token List
* ### Token Detail
* ### Search

---

### Portfolio

* **Functional Requirements**

* **Overview:** The Wallet Portfolio feature provides users with a comprehensive view of their cryptocurrency
holdings, including balances, FT token details, and NFTs.

* **Features:**

* **Portfolio Overview**

* **Description:** Display the total balance and recent performance of the user's wallet.

* **Fields:**

* Token Address/AdaHandle

* Total Balance: Overall value of all holdings.

* Disclaimer Tooltip: “The data is only for your reference; there is no guarantee that the data is
absolutely accurate.”

* Performance Indicator: Percentage change in portfolio value.

* **Your Tokens**

* **Description:** Show a detailed list of tokens in the user's portfolio.

* **Fields:**

* Token Name and Symbol: Displayed with icons.

* Balance: Amount held by the user.

* Current Price and Change: Displayed alongside each token.

* **Your NFTs**

* **Description:** Show a detailed list of NFTs in the user's wallet.

* **Fields:**

* NFT Image: Displayed with a static image; the first frame if the NFT is an animated image.

* NFT Name: Displayed with NFT.

* **Non-Functional Requirements**

* **Performance:** Ensure quick loading times and smooth navigation between tabs.

* **Usability:** Provide an intuitive layout that is easy to navigate and understand.

* **Security:** Ensure secure handling of user data and transactions.

* **Error Handling:** If there is a failure to load portfolio data, display an error message: "Unable to load
portfolio data. Please try again later."

---

### Token List

* **Functional Requirements**
Expand Down
60 changes: 0 additions & 60 deletions docs/CategoryWallet.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,12 @@
# Requirements Details

## Wallet
* ### Portfolio
* ### Create/Restore Wallet
* ### Send/Receive Tokens
* ### Order History

---

### Portfolio

* **Functional Requirements**

* **Overview:** The Wallet Portfolio feature provides users with a comprehensive view of their cryptocurrency
holdings, including balances, FT token details, and NFTs.

* **Features:**

* **Portfolio Overview**

* **Description:** Display the total balance and recent performance of the user's wallet.

* **Fields:**

* Token Address/AdaHandle

* Total Balance: Overall value of all holdings.

* Disclaimer Tooltip: “The data is only for your reference; there is no guarantee that the data is
absolutely accurate.”

* Performance Indicator: Percentage change in portfolio value.

* **Your Tokens**

* **Description:** Show a detailed list of tokens in the user's portfolio.

* **Fields:**

* Token Name and Symbol: Displayed with icons.

* Balance: Amount held by the user.

* Current Price and Change: Displayed alongside each token.

* **Your NFTs**

* **Description:** Show a detailed list of NFTs in the user's wallet.

* **Fields:**

* NFT Image: Displayed with a static image; the first frame if the NFT is an animated image.

* NFT Name: Displayed with NFT.

* **Non-Functional Requirements**

* **Performance:** Ensure quick loading times and smooth navigation between tabs.

* **Usability:** Provide an intuitive layout that is easy to navigate and understand.

* **Security:** Ensure secure handling of user data and transactions.

* **Error Handling:** If there is a failure to load portfolio data, display an error message: "Unable to load
portfolio data. Please try again later."

---

### Create Wallet

* **Functional Requirements**
Expand Down