Skip to content

Commit

Permalink
Improvements (#2)
Browse files Browse the repository at this point in the history
* move content

* Update intro.md

* Update index.js

* clean up

* update

* Update quickstart.md
  • Loading branch information
bucanero authored Jan 23, 2025
1 parent 5f66cdb commit aa46e73
Show file tree
Hide file tree
Showing 9 changed files with 52 additions and 47 deletions.
18 changes: 9 additions & 9 deletions docs/dashboard/intro.md → docs/dashboard.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_position: 1
sidebar_label: "Introduction"
title: Dashboard Overview
sidebar_label: "Dashboard"
title: Dashboard
description: A centralized overview of your treasury's finances.
---

Expand All @@ -15,14 +15,14 @@ The NEAR Treasury dashboard provides a centralized overview of your treasury's f

- **Token Balances:** Below the total balance, you'll find a breakdown of the specific amounts held in each token. This section may include details like:

- **Available Balance:** The amount readily available for spending or other actions.

- **Staked Balance:** The amount currently staked to earn rewards.

- **Pending Release:** For lockup accounts, this shows the amount of tokens scheduled to be released soon.
- **Available Balance:** The amount readily available for spending or other actions.

- **Staked Balance:** The amount currently staked to earn rewards.

- **Pending Release:** For lockup accounts, this shows the amount of tokens scheduled to be released soon.

- **Lockup Balances (if applicable):** If your treasury utilizes lockup accounts, this section displays the balance of tokens held within them. You'll be able to see details about the lockup period and any staking activity associated with those funds.

- **Lockup Balances (if applicable):** If your treasury utilizes lockup accounts, this section displays the balance of tokens held within them. You'll be able to see details about the lockup period and any staking activity associated with those funds.

- **Transaction History:** This section provides a detailed record of all incoming and outgoing transactions. You can filter and sort transactions by date, type (payment, staking, exchange), and token. Click on individual transactions to view more details.

- **Charts and Graphs:** Visual representations of your treasury's activity over time are displayed in this section. You can interact with these charts to adjust the timeframe and see how your treasury's value has fluctuated. This helps you identify trends and make informed decisions about your finances .
Expand Down
40 changes: 12 additions & 28 deletions docs/intro.md → docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Welcome to the NEAR Treasury documentation! This guide will help you get the mos
#### Table of Contents

- [Getting Started](quickstart.md)
- [Dashboard](dashboard/intro.md)
- [Payments](payments/intro.md)
- [Stake Delegation](stake/intro.md)
- [Settings](settings/intro.md)
- [Dashboard](dashboard.md)
- [Payments](payments.md)
- [Stake Delegation](stake.md)
- [Settings](settings.md)

## What is NEAR Treasury?

Expand Down Expand Up @@ -52,40 +52,24 @@ NEAR Treasury is a powerful tool designed to simplify and secure the way teams a

NEAR Treasury is designed with security as a top priority. Here are some key features and recommendations for protecting your treasury:

- Multi-signature security: All important actions, like making payments or changing settings, require approval from multiple team members. This helps prevent unauthorized access and fraudulent transactions.

- Strong passwords: Use complex and unique passwords for your NEAR Treasury account. Avoid reusing passwords from other services.

- Two-factor authentication (2FA): Enable 2FA for an extra layer of security. This adds an additional verification step when logging in.

- Regular security audits: Conduct regular security audits to identify and address potential vulnerabilities .

- Stay updated: Keep your NEAR Treasury software up-to-date with the latest security patches and updates.

- Educate your team: Ensure all team members are aware of security best practices and potential threats.

- Secure Key Management: Employ robust methods for storing and managing private keys, such as hardware security modules (HSMs) or secure enclaves .

- Transaction Verification: Implement rigorous signature verification procedures to prevent unauthorized transactions .

- Access Control: Enforce strict access control measures, including multi-factor authentication and role-based permissions, to limit access to sensitive information and functionalities .

- Data Encryption: Encrypt all sensitive data both in transit and at rest to protect against data breaches .

- Secure Communication: Ensure secure communication channels between users and the system, as well as between different components of the system .
- **Multi-signature security:** All important actions, like making payments or changing settings, require approval from multiple team members. This helps prevent unauthorized access and fraudulent transactions.

- **Secure Key Management:** Employ robust methods for storing and managing private keys, such as hardware wallets or secure enclaves.

- **Educate your team:** Ensure all team members are aware of security best practices and potential threats.

- **Access Control:** Enforce strict access control measures using role-based permissions, to limit access to sensitive information and functionalities.


## Troubleshooting

While NEAR Treasury is designed to be user-friendly and reliable, issues can sometimes arise. Here are some common problems and solutions:

- **_I forgot my password_**: If you forget your password, you can usually reset it by following the instructions on the login screen.

- **_I'm having trouble approving a request_**: Ensure you have the necessary permissions and that the request is still pending. If the issue persists, check the voting duration settings.

- **_My transaction is not going through_**: Verify that you have sufficient funds and that the recipient's wallet address is correct. If the issue continues, check the status of the NEAR network.


:::tip
If you encounter a problem that's not listed here, please contact the [NEAR Treasury support team](#) for assistance.
If you encounter a problem that's not listed here, please contact the [NEAR Treasury support team](https://neartreasury.com/contact-form) for assistance.
:::
6 changes: 3 additions & 3 deletions docs/payments/intro.md → docs/payments.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_position: 1
sidebar_label: "Introduction"
title: Payments Overview
sidebar_position: 2
sidebar_label: "Payments"
title: Payments
description: Core features for managing your treasury's funds.
keywords: [NEAR Treasury, Payments]
---
Expand Down
12 changes: 11 additions & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 0
title: Quick Start
sidebar_label: "Quick Start"
title: Quick Start Guide
description: Introduction
---

Expand Down Expand Up @@ -73,3 +74,12 @@ _(e.g., `My Near Treasury`)_
<center>
<img src="/img/create/treasury-creation-7.png" width="60%" />
</center>

## Next steps

Now that you have your Treasury up and running, be sure to check the following articles to learn more about the available features:

- [Dashboard](dashboard.md)
- [Payments](payments.md)
- [Stake Delegation](stake.md)
- [Settings](settings.md)
3 changes: 2 additions & 1 deletion docs/settings/intro.md → docs/settings.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 0
sidebar_position: 4
sidebar_label: "Settings"
title: Settings Overview
description: Configure your NEAR Treasury dashboard.
---
Expand Down
6 changes: 3 additions & 3 deletions docs/stake/intro.md → docs/stake.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_position: 1
sidebar_label: Introduction
title: Stake Delegation Overview
sidebar_position: 3
sidebar_label: Stake Delegation
title: Stake Delegation
description: Stake and unstake your treasury's tokens.
---
import Tabs from '@theme/Tabs';
Expand Down
12 changes: 11 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,17 @@ const config = {
{
label: "Documentation",
position: "left",
to: "/intro"
to: "/"
},
{
label: "Web site",
position: "left",
to: "https://neartreasury.com/"
},
{
label: "Contact us",
position: "right",
to: "https://neartreasury.com/contact-form"
},
{
href: 'https://github.com/NEAR-DevHub/treasury-docs',
Expand Down
2 changes: 1 addition & 1 deletion src/components/HomepageContent/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export default function HomepageContent() {
Svg={require('@site/static/img/operations.svg').default}
title="Payments"
description="Core features for managing your funds."
to="/payments/intro"
to="/payments"
/>
</section>
</div>
Expand Down
File renamed without changes.

0 comments on commit aa46e73

Please sign in to comment.