Skip to content

Docs Improvement and translation integrations #52

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

Merged
merged 21 commits into from
May 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
92d02a0
feat(Ask Core): Cookbook Onboard integration
AE-0h Apr 18, 2025
9150d9a
Merge https://github.com/MarryamZulfiqar/CoreDAO-Docs into cookbook-m…
MarryamZulfiqar Apr 28, 2025
6cec1dc
Update docusaurus.config.ts
MarryamZulfiqar Apr 28, 2025
d3706c9
Merge pull request #2 from MarryamZulfiqar/cookbook-merged
MarryamZulfiqar Apr 28, 2025
118ab4b
Update docusaurus.config.ts
MarryamZulfiqar Apr 28, 2025
5cacc54
Merge branch 'coredao-org:main' into main
MarryamZulfiqar May 8, 2025
aed6e0e
Updated Validator Node Setup and Registration Guides
MarryamZulfiqar May 8, 2025
d545908
updated snapshot and releases links
MarryamZulfiqar May 9, 2025
62b294e
fixed typos
MarryamZulfiqar May 9, 2025
b197ee1
spanish transaltion integration
MarryamZulfiqar May 9, 2025
564eb11
fixed order to cammand executions
MarryamZulfiqar May 12, 2025
ebbb656
added steps to sync form gensis and snapshot
MarryamZulfiqar May 13, 2025
f41dd14
fixed typo
MarryamZulfiqar May 13, 2025
a6af4ee
added details of how to update validator name
MarryamZulfiqar May 16, 2025
885699a
update validator name steps
MarryamZulfiqar May 18, 2025
6021fa1
resolved image load issues
MarryamZulfiqar May 18, 2025
b7f6f11
french transalations integration
MarryamZulfiqar May 19, 2025
ae4440a
fixed missed links in french tanslations
MarryamZulfiqar May 19, 2025
cb8ad77
fixed sidebar issues
MarryamZulfiqar May 20, 2025
466b526
fixed typos
MarryamZulfiqar May 20, 2025
40d1177
Merge branch 'coredao-org:main' into main
MarryamZulfiqar May 20, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions docs/Dev-Guide/core-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ hide_table_of_contents: false
sidebar_position: 2
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Core Scan Blockchain Explorer

---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Core Explorer is a graphic user interface designed to allow users to interact with the CORE blockchain. Through this interface, a user can browse information about blocks that have been added to the blockchain, transactions that have occurred on the blockchain, wallet balances, and information about tCORE and CORE tokens. Core Network provides explorers for both its mainnet and testnet.

<Tabs defaultValue="mainnet" values={[
Expand Down
6 changes: 3 additions & 3 deletions docs/Dev-Guide/core-wallet-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ hide_table_of_contents: false
sidebar_position: 2
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Connect to Core Testnet

---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

:::note
This is a detailed guideline for connecting to Core Testnet/Mainnet using the MetaMask wallet.
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/Dev-Guide/dapp-on-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ main().catch((error) => {
});
```

3. Make sure your MetaMask wallet has tCORE or tCORE2 test tokens for the Core Testnets. Refer [here](https://docs.coredao.org/docs/Dev-Guide/core-wallet-config) for details on how to get tCORE or tCORE2 tokens from Core Faucet.
3. Make sure your MetaMask wallet has tCORE or tCORE2 test tokens for the Core Testnets. Refer [here](https://docs.coredao.org/docs/Dev-Guide/core-wallet-config.md) for details on how to get tCORE or tCORE2 tokens from Core Faucet.

4. Run the following command from the root directory of your project, to deploy your smart contract on the Core blockchain.

Expand Down
5 changes: 3 additions & 2 deletions docs/Dev-Guide/network-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ hide_table_of_contents: false
sidebar_position: 2
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Core Network Configurations

---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs defaultValue="testnet2" values={[
{label: 'Testnet2', value: 'testnet2'},
Expand Down
4 changes: 2 additions & 2 deletions docs/FAQs/delegator-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ In the Core ecosystem, delegation is a fundamental mechanism that allows BTC min

### 3. How can one delegate CORE tokens in Core?

By delegating CORE to Validators, CORE holders can help secure the network and share in system rewards. Please refer to the detailed [guide](../stake-and-delegate/delegating-core) on CORE Delegation for more details.
By delegating CORE to Validators, CORE holders can help secure the network and share in system rewards. Please refer to the detailed [guide](../stake-and-delegate/delegating-core.md) on CORE Delegation for more details.

<!-- ### 4. What are the minimum staking period requirements for BTC and BTC Hash Power delegation?
For BTC and BTC hash power delegation the minimum requirement is that of **10** days, i.e., you cannot un-delegate your stake prior to **10** days. Technically, (\`CLTV timestamp - transaction confirmation timestamp > 10 days\`). -->
Expand All @@ -30,7 +30,7 @@ This type of delegation allows BTC and CORE token holders to support specific va

### 5. How does one delegate hash power on Core netowrk?

By delegating hash power to Validators, BTC miners can help secure the network and get share in system rewards. Please refer to the detailed [guide](../stake-and-delegate/delegating-hash) on hash power delegation for more details.
By delegating hash power to Validators, BTC miners can help secure the network and get share in system rewards. Please refer to the detailed [guide](../stake-and-delegate/delegating-hash.md) on hash power delegation for more details.

### 6. How can a delegator maximize their rewards?

Expand Down
2 changes: 1 addition & 1 deletion docs/FAQs/dual-staking-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The act of delegators rebalancing their delegation to maximize reward is the dri

### 7\. Is there any risk of losing your Bitcoin assets during dual staking?

Dual Staking is a [self-custodial process](../Learn/products/btc-staking/overview), allowing users to maintain full control over their assets. Throughout the staking process, Bitcoin remains securely in the user’s wallet. Stakers face no slashing risk, external smart contract risk, or counterparty risk. The trust assumptions for staking Bitcoin are the same trust assumptions underlying holding Bitcoin.
Dual Staking is a [self-custodial process](../Learn/products/btc-staking/overview.md), allowing users to maintain full control over their assets. Throughout the staking process, Bitcoin remains securely in the user’s wallet. Stakers face no slashing risk, external smart contract risk, or counterparty risk. The trust assumptions for staking Bitcoin are the same trust assumptions underlying holding Bitcoin.

### 8\. While Bitcoin is timelocked, can users unstake CORE that’s dual staked with Bitcoin? If so, do they lose any rewards earned prior to unstaking CORE?

Expand Down
2 changes: 1 addition & 1 deletion docs/FAQs/validator-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In the Core ecosystem, "validator" refers to nodes or participants in the blockc

### 2. How to Become a Validator?

- 1. To register as a validator on Core you must be running a full node in validator mode. Please read the guides on [configuring validator nodes](../Node/config/validator-node-config) and [running validator nodes](../Node/validator/running-validator) for information on how to set this up.
- 1. To register as a validator on Core you must be running a full node in validator mode. Please read the guides on [validator nodes requirements](../Node/config/validator-node-config.md) and [setting up validator nodes](../Node/validator/setting-up-validator.md) for information on how to set this up.
2. Once that’s finished, the easiest way to register a new validator is using one of our staking websites:
1. [Mainnet stake website](https://stake.coredao.org)
2. [Testnet stake website](https://stake.test.btcs.network)
Expand Down
2 changes: 1 addition & 1 deletion docs/Learn/products/btc-staking/dual-staking-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ There are several ways to participate in Dual Staking with BTC and CORE, dependi
To get started and be able to dual stake CORE and BTC via Core's [official staking website](https://stake.coredao.org/staking), you must have the following prerequisites:

1. **Supported Bitcoin Wallet Browser Extension:** To participate in the BTC staking process, you must install browser extensions of any supported Bitcoin wallets, like [Xverse](https://chromewebstore.google.com/detail/xverse-wallet/idnnbdplmphpflfnlkomgpfbpcgelopg?hl=en-GB&authuser=1), [Unisat](https://chromewebstore.google.com/detail/unisat-wallet/ppbibelpcjmhbdihakflkdcoccbgbkpo), and/or [OKX Wallet](https://chromewebstore.google.com/detail/okx-wallet/mcohilncbfahbmgdjkbpemcciiolgcge) (refer [here](https://stake.coredao.org) for the latest supported wallets). You must use a desktop version, when using the official staking website. You can also stake directly using the [Element wallet](https://www.elementwallet.com/) mobile application as well.
2. **Core Wallet Address for Rewards:** Prepare your Core wallet address to stake CORE and receive [CORE token rewards for staking Bitcoin](https://docs.coredao.org/docs/Learn/products/btc-staking/stake-btc-guide#prerequisites). If you do not have a Core wallet address, you can quickly create one by connecting to MetaMask. For more information on configuring MetaMask to work with the Core network, follow the detailed guide [here](https://docs.coredao.org/docs/Dev-Guide/core-mainnet-wallet-config).
2. **Core Wallet Address for Rewards:** Prepare your Core wallet address to stake CORE and receive [CORE token rewards for staking Bitcoin](https://docs.coredao.org/docs/Learn/products/btc-staking/stake-btc-guide#prerequisites). If you do not have a Core wallet address, you can quickly create one by connecting to MetaMask. For more information on configuring MetaMask to work with the Core network, follow the detailed guide [here](https://docs.coredao.org/docs/Dev-Guide/core-mainnet-wallet-config.md).

## Key Considerations For Dual Staking

Expand Down
2 changes: 1 addition & 1 deletion docs/Learn/products/btc-staking/stake-btc-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This user guide is designed to walk you through staking your Bitcoin on the Core
To be able to stake, you must have the following prerequisites:

1. **Supported Bitcoin Wallet Browser Extension:** To participate in the BTC staking process, you must install browser extensions of any supported Bitcoin wallets, like [Xverse](https://chromewebstore.google.com/detail/xverse-wallet/idnnbdplmphpflfnlkomgpfbpcgelopg?hl=en-GB&authuser=1), [Unisat](https://chromewebstore.google.com/detail/unisat-wallet/ppbibelpcjmhbdihakflkdcoccbgbkpo), and/or [OKX Wallet](https://chromewebstore.google.com/detail/okx-wallet/mcohilncbfahbmgdjkbpemcciiolgcge) (visit stake.coredao.org for the latest supported wallets). You must use a desktop version, as mobile and hardware wallets are not currently supported. You can also stake directly using the [Element Wallet](https://www.elementwallet.com/) mobile application as well.
2. **Core Wallet Address for Rewards:** Prepare your Core wallet address to receive CORE token rewards for staking Bitcoin. If you do not have a Core wallet address, you can quickly create one by connecting to MetaMask. For more information on configuring MetaMask to work with the Core network, follow the detailed guide [here](https://docs.coredao.org/docs/Dev-Guide/core-mainnet-wallet-config).
2. **Core Wallet Address for Rewards:** Prepare your Core wallet address to receive CORE token rewards for staking Bitcoin. If you do not have a Core wallet address, you can quickly create one by connecting to MetaMask. For more information on configuring MetaMask to work with the Core network, follow the detailed guide [here](https://docs.coredao.org/docs/Dev-Guide/core-mainnet-wallet-config.md).

## **Key Considerations For BTC Staking**

Expand Down
14 changes: 7 additions & 7 deletions docs/Node/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sidebar_position: 2

In the Core ecosystem, the robustness, security, and decentralization of the network are upheld by the nodes operated by community participants. These nodes facilitate various functions, from transaction validation to block propagation, ensuring the network's overall health and efficiency.

Depending on your goals, there are different node configurations possible on the Core network. If you haven't already started any node on Core network yet, please review the documentation for [Running a Local Validator Node](./validator/running-validator.md) before proceeding with different configurations.
Depending on your goals, there are different node configurations possible on the Core network. If you haven't already started any node on Core network yet, please review the documentation before proceeding with different configurations.

* **If you want to be part of the governance of the Core Nework**

Expand All @@ -32,15 +32,15 @@ Depending on your goals, there are different node configurations possible on the
* [**Start a Snapshot Node**](./config/snapshot-node-config.md)

## Types of Nodes on the Core Network
1. **Validators:**
* **Role:** Validators are crucial for securing the network by producing blocks and validating transactions within the Core blockchain’s consensus framework.
* **Requirements:** Validators need to stake minimum amount of **10,000 CORE tokens** to participate, aligning their financial incentives with the network's performance and security.
* **Incentives:** Validators earn rewards in CORE tokens for their active role in maintaining and securing network operations.

2. **Normal Full Nodes:**
1. **Normal Full Nodes:**
* **Role:** Normal Full Nodes maintain a complete, real-time copy of the blockchain ledger, validate transactions, and support the network by relaying block and transaction data. These are essentially useful for private use.
* **Requirements:** Operating a Full Node requires significant computational and storage resources to handle the complete blockchain data and continuous network traffic.

2. **Validators:**
* **Role:** Validators are crucial for securing the network by producing blocks and validating transactions within the Core blockchain’s consensus framework. These are essentially full nodes running in validator mode.
* **Requirements:** Validators need to stake minimum amount of **10,000 CORE tokens** to participate, aligning their financial incentives with the network's performance and security.
* **Incentives:** Validators earn rewards in CORE tokens for their active role in maintaining and securing network operations.

3. **RPC Nodes:**
* **Role:** RPC Nodes provide an application programming interface (API) for developers and external applications to interact with the blockchain, facilitating queries and transactions.
* **Importance:** They are essential for the development and operation of decentralized applications (DApps) and for external access to the blockchain’s data.
Expand Down
Loading