Skip to content

Commit

Permalink
Merge branch 'main' into drew/fix-testnet-explorer-link
Browse files Browse the repository at this point in the history
  • Loading branch information
@drewstone
drewstone authored Jan 19, 2024
2 parents 4ca592e + 37e3197 commit 0d2ba67
Show file tree
Hide file tree
Showing 27 changed files with 90 additions and 115 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/checks.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,9 @@ jobs:
access_token: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/checkout@v3
- name: Link Checker
uses: lycheeverse/lychee-action@v1.5.4
uses: lycheeverse/lychee-action@v1.9.0
with:
args: --verbose --no-progress './**/*.md' './**/*.html' './**/*.mdx'
fail: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2 changes: 2 additions & 0 deletions .lycheeignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
http://localhost*
https://localhost*
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,15 @@ navigation.

```bash
# create a new folder to get going
git clone https://github.com/webb-tools/webb-docs.git
git clone https://github.com/webb-tools/tangle-docs.git
```

2. **Install dependencies**

Navigate into your new site’s directory and install all dependencies.

```bash
cd webb-docs/
cd tangle-docs/
yarn install
```

Expand Down
21 changes: 7 additions & 14 deletions components/CommonActions.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,20 +52,13 @@ const features = [
href: "https://polkadot.js.org/apps/?rpc=wss://testnet-rpc.tangle.tools#/democracy",
action: "Interact with Governance",
},
{
Icon: BeakerIcon,
title: "Faucet",
description: `Our easy-to-use testnet faucet allows you to claim test tokens with just a few clicks. Start experimenting with Hubble Bridge today.`,
href: "https://faucet.tangle.tools",
action: "Go to Faucet",
},
{
Icon: ChartBarIcon,
title: "DKG Stats dApp",
description: `The DKG Stats dApp provides insights into the DKG protocol running on the Tangle Network.`,
href: "https://stats.tangle.tools",
action: "View DKG Functionality",
},
// {
// Icon: BeakerIcon,
// title: "Faucet",
// description: `Our easy-to-use testnet faucet allows you to claim test tokens with just a few clicks. Start experimenting with Hubble Bridge today.`,
// href: "https://faucet.tangle.tools",
// action: "Go to Faucet",
// },
];

const Card = ({ Icon, title, description, href, action }) => (
Expand Down
12 changes: 2 additions & 10 deletions components/QuickStart.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,14 @@ export const DappsArea = () => {
}}
href="https://app.webb.tools"
/>
<DetailedFeatureLink
{/* <DetailedFeatureLink
feature={{
Icon: BeakerIcon,
description: `Our easy-to-use testnet faucet allows you to claim test tokens with just a few clicks. Start experimenting with Hubble Bridge today.`,
name: "Faucet dApp",
}}
href="https://faucet.tangle.tools"
/>
<DetailedFeatureLink
feature={{
Icon: ChartBarIcon,
description: `The DKG Stats dApp provides insights into the DKG protocol running on the Tangle Network.`,
name: "DKG Stats dApp",
}}
href="https://stats.tangle.tools"
/>
/> */}
<DetailedFeatureLink
feature={{
Icon: ChartSquareBarIcon,
Expand Down
8 changes: 0 additions & 8 deletions components/RepoArea.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,6 @@ export const RepoArea = () => {
export const StatsdApp = () => {
return (
<div className="grid grid-cols-1 mt-10 gap-x-6 gap-y-12 sm:grid-cols-2 lg:mt-10 lg:gap-x-8 lg:gap-y-12">
<DetailedFeatureLink
feature={{
Icon: ChartBarIcon,
description: `The Stats dApp provides insights into the DKG protocol running on the Tangle Network.`,
name: "Tangle DKG Stats dApp",
}}
href="https://stats.tangle.tools"
></DetailedFeatureLink>
<DetailedFeatureLink
feature={{
Icon: GitHubIcon,
Expand Down
2 changes: 1 addition & 1 deletion components/TangleQuickstart.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ export const MonitoringArea = () => {
description: `Power your metrics and alerting with the leading open-source monitoring solution.`,
name: "Prometheus Setup",
}}
href="docs/node/monitoring/prometheus/"
href="/docs/node/monitoring/prometheus/"
></DetailedFeatureLink>
<DetailedFeatureLink
feature={{
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "next start",
"build": "next build",
"export": "next export",
"lint": "next lint",
"lint": "next lint && yarn format",
"schema": "turbo-gen ./public/schema.json",
"format": "prettier --write \"{components,pages}/**/*.{mdx,ts,js,jsx,tsx,json}\" ",
"format:check": "prettier --check \"{components,pages}/**/*.{mdx,ts,js,jsx,tsx,json}\" "
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/_meta.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"node": "Node",
"governance": "Govern",
"community": "Community",
"faqs": "FAQs",
"faq": "FAQ",
"glossary": "Glossary",
"contribute": "Contribute or Submit a Bug",
"webb_docs_link": {
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/build/pallets/balances-and-accounts.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ The Balances pallet provides a versatile API that allows interaction from within
- `unreserve`: Unreserve some funds, returning any amount that was unable to be unreserved.
- `slash`: Deducts up to a value from the combined balance of `who`, preferring to deduct from the free balance. This function cannot fail.

Please refer to the [official API documentation](https://substrate.dev/rustdocs/latest/pallet_balances/index.html) to learn more about the API provided by the Balances
Please refer to the [official API documentation](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html) to learn more about the API provided by the Balances
2 changes: 1 addition & 1 deletion pages/docs/build/pallets/consensus-mechanism.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ Key functions of the Staking pallet include:
- `nominate`: A bonded account can nominate one or more validators to be elected.
- `payout_stakers`: Pay the last reward to the stakers of a validator.

Please refer to the [official API documentation](https://substrate.dev/rustdocs/latest/pallet_staking/index.html) to learn more about the API provided by the Staking pallet.
Please refer to the [official API documentation](https://crates.parity.io/pallet_staking/index.html) to learn more about the API provided by the Staking pallet.
2 changes: 1 addition & 1 deletion pages/docs/build/pallets/interoperability.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Interoperability

Tangle Network is designed to connect to other blockchains through bridges, and is specially designed to govern and host connections to Webb's bespoke Hubble Bridge, a private and interoperable transfer bridge.
See Hubble at https://app.webb.tools or the [Docs for Hubble Bridge](/docs/projects/hubble-bridge/overview)
See Hubble at https://app.webb.tools or the [Docs for Hubble Bridge](https://docs.webb.tools/docs/projects/hubble-bridge/overview/)
8 changes: 4 additions & 4 deletions pages/docs/faqs.mdx → pages/docs/faq.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The following specifications are the ideal or recommended, but nodes can be run
| Memory | 32GB ECC |
| Firewall | P2P port must be open to incoming traffic: <br /> - Source: Any <br /> - Destination: 30333, 30334 TCP |

See https://docs.webb.tools/docs/ecosystem-roles/validator/requirements/ for more information.
See [Hardware](https://docs.tangle.tools/docs/node/hardware/) and [Getting Started with Validating](https://docs.tangle.tools/docs/node/validator/requirements/) for more information.

## What about backup nodes?

Expand Down Expand Up @@ -60,23 +60,23 @@ We're working on this, check back soon!

## What are the recommendations for monitoring my node?

Monitoring is critical for success as a node operator. See our full Monitoring guide at https://docs.webb.tools/docs/node/monitoring/quickstart//
Monitoring is critical for success as a node operator. See our full [Monitoring guide](https://docs.tangle.tools/docs/node/monitoring/quickstart/)

## What are the KPIs I should be monitoring?

The main key performance indicator for a node operator is the number of blocks produced. The Prometheus metric for this is called substrate_proposer_block_constructed_count.

## How should I set up alerting?

Alerting is critical for your success as a node operator, see our full guide to using our recommended AlertManager at https://docs.webb.tools/docs/node/monitoring/alert-manager/
Alerting is critical for your success as a node operator, see our full guide to using our recommended AlertManager (https://docs.tangle.tools/docs/node/monitoring/alert-manager/)

## What is the failover process if my primary node is down?

When the primary server is down, the best way to perform a failover to the backup server is to perform a key association update. Each server should have a unique set of keys already. Run the setKeys author mapping extrinsic. You can follow the Mapping Extrinsic instructions and modify the instructions to use the setKeys extrinsic.

## What should I look for in the logs?

For full support, see our guides on logging at https://docs.webb.tools/docs/node/monitoring/loki/.
For full support, see our guides on [Logging](https://docs.tangle.tools/docs/node/monitoring/loki/).

## How much stake do I need to become a validator in the active set?

Expand Down
2 changes: 1 addition & 1 deletion pages/docs/governance/democracy-voting.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Note: This guide assumes you have already set up a Substrate-based wallet and ha
8. **Wait for the Voting Period to End:**
Each referendum has a voting period. When this period ends, votes are tallied, and the decision is enacted based on the majority vote.

Remember that **voting in a referendum will lock your tokens until the end of the enactment period (if the proposal passes) or until the end of the voting period (if the proposal does not pass).** The length of these periods can vary, refer to [our parameters.](/docs/governance/governance-parameters/)
Remember that **voting in a referendum will lock your tokens until the end of the enactment period (if the proposal passes) or until the end of the voting period (if the proposal does not pass).** The length of these periods can vary, refer to [our parameters.](./governance-parameters.mdx)
2 changes: 1 addition & 1 deletion pages/docs/governance/overview.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The governance system of Tangle Network is divided into two parts, the public re

Proposals can be made by any token holder. Others can agree with the proposal by seconding it and providing tokens equivalent to the original bond. The most seconded proposal during every launch period is moved to the public referenda table for active voting. Voters can lock their tokens for a longer duration to amplify their vote.

Detailed information on the governance system can be found [here](/docs/governance/overview/).
Detailed information on the governance system can be found [here](https://marketplace.substrate.io/pallets/pallet-democracy/).

## Important Parameters for Democracy Module

Expand Down
48 changes: 21 additions & 27 deletions pages/docs/network-information-configuration.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Before you dive into development, it's crucial to familiarize yourself with the

| Network | Network Type | Native Asset Symbol | Native Asset Decimals |
| -------------- | ------------ | ------------------- | --------------------- |
| Tangle Network | MainNet | TNT | 18 |
| Tangle Testnet | TestNet | tTNT | 18 |
| Tangle Network | Mainnet | TNT | 18 |
| Tangle Testnet | Testnet | tTNT | 18 |

## Network Configurations

Expand All @@ -33,16 +33,12 @@ We will offer two types of block explorers to accommodate the Ethereum API and S

| Block Explorer | Type | URL |
| -------------- | --------- | ---------------------------------------------------------------------------------- |
| BlockScout | EVM | [link](https://https://testnet-explorer.tangle.tools/) |
| BlockScout | EVM | [link](https://testnet-explorer.tangle.tools/) |
| PolkadotJS | Substrate | [link](https://polkadot.js.org/apps/?rpc=wss://testnet-rpc.tangle.tools#/explorer) |

## Funding Your Accounts

Before starting development on our TestNets, fund your account with tTNT tokens, strictly intended for testing purposes and devoid of real-world value. You can obtain this at [Webb Faucet](https://faucet.webb.tools/.)

| Network | Source For Tokens |
| -------------- | -------------------------- |
| Tangle Testnet | https://faucet.webb.tools/ |
Before starting development on our TestNets, fund your account with tTNT tokens, strictly intended for testing purposes and devoid of real-world value. You can obtain this on our Discord server [Faucet channel](https://discord.com/channels/833784453251596298/1183826417625075753)

## Development Tools

Expand All @@ -58,7 +54,7 @@ As an Ethereum-compatible, Substrate-based chain, Tangle Network allows for the

## Participating in the Tangle Network

Joining the Tangle Network community is easy. You can run a node, develop a Dapp, or contribute to our open-source codebase. For more information, visit our [Node Operation Guide](/docs/node/quickstart/), and [Contribution Guide](/docs/contribute).
Joining the Tangle Network community is easy. You can run a node, develop a Dapp, or contribute to our open-source codebase. For more information, visit our [Node Operation Guide](./node/quickstart.mdx), and [Contribution Guide](./contribute.mdx).

## Looking Ahead: Mainnet Launches

Expand All @@ -68,23 +64,21 @@ Our official Mainnet launch date is forthcoming, so stay tuned! Post-launch, we'

Users can participate by engaging in the following activities, you can share your contributions to [our Discord](https://webb.tools/community) in the `#contributions` channel.

| Task | Instructions |
| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| Creative Contribution | - |
| Use Case Concepts | User Submission. Write an article discussing a use case for the technologies Tangle uses! |
| Publish a video or tutorial on Tangle/Webb | Publish a high-quality video discussing the network or its privacy technologies. |
| Author a Protocol Extension | Create and submit an extension to the protocols used in Tangle. See our GitHub |
| Tweet a Semaphore identity w/ Webb | Share your [Semaphore identity](https://semaphore.appliedzkp.org/docs/guides/identities) and tag [@webbprotocol](https://twitter.com/webbprotocol) |
| DKG Authority (get voted in) | See our DKG documentation |
| Tweet about Webb | Tag [@webbprotocol](https://twitter.com/webbprotocol) in a high quality tweet about the network. |
| Deposit → Transfer → Withdraw | Perform a transaction flow on the network or the Hubble Bridge. |
| Tweet a hash of your address + a secret number | Make sure to tag @Webbprotocol. |
| Vote in Governance | See the Polkadot Governance Docs for [how to participate in Substrate governance.](https://wiki.polkadot.network/docs/maintain-guides-democracy) |
| Propose and Pass in Governance | See the Polkadot Governance Docs for [how to participate in Substrate governance.](https://wiki.polkadot.network/docs/maintain-guides-democracy) |
| Tweet an ETH address or ENS domain | Tag [@webbprotocol](https://twitter.com/webbprotocol) in a high quality tweet about the network. |
| Bug Bounty with PR Fix Submission | See our Docs on Contributing a Bug Bounty, and provide a fix for the bug via Github. |
| Run a validator | See our Docs on running a Validator Node |
| Scripts to make Transactions | Engineer and publish transaction scripts for the network |
| Bug Report | See the @Bug Reporting Guidance |
| Task | Instructions |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Creative Contribution | - |
| Use Case Concepts | User Submission. Write an article discussing a use case for the technologies Tangle uses! |
| Publish a video or tutorial on Tangle/Webb | Publish a high-quality video discussing the network or its privacy technologies. |
| Author a Protocol Extension | Create and submit an extension to the protocols used in Tangle. See our GitHub |
| Tweet about Webb | Tag [@webbprotocol](https://twitter.com/webbprotocol) in a high quality tweet about the network. |
| Deposit → Transfer → Withdraw | Perform a transaction flow on the network or the Hubble Bridge. |
| Tweet a hash of your address + a secret number | Make sure to tag @Webbprotocol. |
| Vote in Governance | See the Polkadot Governance Docs for [how to participate in Substrate governance.](https://wiki.polkadot.network/docs/maintain-guides-democracy) |
| Propose and Pass in Governance | See the Polkadot Governance Docs for [how to participate in Substrate governance.](https://wiki.polkadot.network/docs/maintain-guides-democracy) |
| Tweet an ETH address or ENS domain | Tag [@webbprotocol](https://twitter.com/webbprotocol) in a high quality tweet about the network. |
| Bug Bounty with PR Fix Submission | See our Docs on Contributing a Bug Bounty, and provide a fix for the bug via Github. |
| Run a validator | See our Docs on running a Validator Node |
| Scripts to make Transactions | Engineer and publish transaction scripts for the network |
| Bug Report | See the @Bug Reporting Guidance |

Stay updated by following our [Blog](https://blog.webb.tools /) and joining our [Community](https://webb.tools/community).
Loading

0 comments on commit 0d2ba67

Please sign in to comment.