From f2152729e42f7ff24464011ae7e50cc983b841c1 Mon Sep 17 00:00:00 2001 From: bobinstein Date: Mon, 9 Dec 2024 16:03:06 -0500 Subject: [PATCH] chore: docs cleanup --- .../theme/configs/default_sidebar_config.js | 98 +++++++++---------- docs/src/community-resources.md | 2 +- docs/src/gateway-network.md | 3 +- .../gateways/ar-io-node/arnsoip/observer.md | 14 +-- docs/src/gateways/ar-io-node/testnet.md | 6 +- docs/src/glossary.md | 6 +- docs/src/guides/sdk.md | 2 +- docs/src/index.md | 2 +- docs/src/introduction.md | 2 +- docs/src/token.md | 2 +- 10 files changed, 69 insertions(+), 68 deletions(-) diff --git a/docs/src/.vuepress/theme/configs/default_sidebar_config.js b/docs/src/.vuepress/theme/configs/default_sidebar_config.js index 3d9f0f30..3c8187f9 100644 --- a/docs/src/.vuepress/theme/configs/default_sidebar_config.js +++ b/docs/src/.vuepress/theme/configs/default_sidebar_config.js @@ -5,7 +5,7 @@ module.exports = [ }, { title: "White Paper", - path: "https://arweave.net/lNjWn3LpyhKC95Kqe-x8X2qgju0j98MhucdDKK85vc4", + path: "https://whitepaper_ar-io.arweave.net", }, { title: "Network Overview", @@ -19,7 +19,7 @@ module.exports = [ path: "/arweave", }, { - title: "The IO Token", + title: "The ARIO Token", path: "/token.md", }, { @@ -96,10 +96,10 @@ module.exports = [ title: "AR.IO Admin API", path: "/gateways/ar-io-node/admin/admin-api", }, - { - title: "Upgrading to Observer", - path: "/gateways/ar-io-node/observer-upgrade", - }, + // { + // title: "Upgrading to Observer", + // path: "/gateways/ar-io-node/observer-upgrade", + // }, { title: "Certbot Setup", children: [ @@ -178,32 +178,32 @@ module.exports = [ { title: "Guides", children: [ - { - title: "Arweave Name System (ArNS)", - children: [ - { - title: "ArNS App", - children: [ - { - title: "Overview", - path: "/guides/arns/overview", - }, - { - title: "Registering a Name", - path: "/guides/arns/registering", - }, - { - title: "Managing Assets", - path: "/guides/arns/managing", - }, - ], - }, - { - title: "ANTs on Bazar", - path: "/guides/ants-on-bazar" - }, - ], - }, + // { + // title: "Arweave Name System (ArNS)", + // children: [ + // { + // title: "ArNS App", + // children: [ + // { + // title: "Overview", + // path: "/guides/arns/overview", + // }, + // { + // title: "Registering a Name", + // path: "/guides/arns/registering", + // }, + // { + // title: "Managing Assets", + // path: "/guides/arns/managing", + // }, + // ], + // }, + // { + // title: "ANTs on Bazar", + // path: "/guides/ants-on-bazar" + // }, + // ], + // }, { title: "GraphQL", path: "/guides/gql", @@ -212,23 +212,23 @@ module.exports = [ title: "Deploy a Website or Application", path: "/guides/github-flow" }, - { - title: "Experimental", - children: [ - { - title: "AO ArNS Resolver", - path: "/experimental/ao-resolver", - }, - { - title: "AO ANT", - path: "/experimental/ao-ant", - }, - { - title: "Farcaster Frames", - path: "/gateways/ar-io-node/experimental/frames", - }, - ], - }, + // { + // title: "Experimental", + // children: [ + // { + // title: "AO ArNS Resolver", + // path: "/experimental/ao-resolver", + // }, + // { + // title: "AO ANT", + // path: "/experimental/ao-ant", + // }, + // { + // title: "Farcaster Frames", + // path: "/gateways/ar-io-node/experimental/frames", + // }, + // ], + // }, { title: "Projects", children: [ diff --git a/docs/src/community-resources.md b/docs/src/community-resources.md index f19fb3eb..be4ac3e6 100644 --- a/docs/src/community-resources.md +++ b/docs/src/community-resources.md @@ -11,4 +11,4 @@ next: false [ar.io Discord](https://discord.gg/7zUPfN4D6g) -[Contact Us Directly](mailto:info@ar.io) \ No newline at end of file + \ No newline at end of file diff --git a/docs/src/gateway-network.md b/docs/src/gateway-network.md index 0fdf9b36..dbcf1ab2 100644 --- a/docs/src/gateway-network.md +++ b/docs/src/gateway-network.md @@ -83,6 +83,7 @@ In the AR.IO Network, "staking" designates the act of locking a specified amount It is important to note that unlike other protocols, the ARIO token is non-inflationary. Therefore, the staking mechanism in the AR.IO Network is not designed to function as a yield-generation tool. By staking their tokens, participants become eligible for potential rewards, fostering an atmosphere of mutual trust within the network. Specifically, Gateway operators stake tokens to facilitate their Gateway integration and establish public trust. Once connected, they become eligible for rewards driven by the protocol and gain access to the network's shared resources. + diff --git a/docs/src/gateways/ar-io-node/arnsoip/observer.md b/docs/src/gateways/ar-io-node/arnsoip/observer.md index cc2d053c..f712f34b 100644 --- a/docs/src/gateways/ar-io-node/arnsoip/observer.md +++ b/docs/src/gateways/ar-io-node/arnsoip/observer.md @@ -23,7 +23,7 @@ The Observation protocol is organized around epochs, periods of time that are br
Observation and Incentive Protocol
- To participate in the epoch, a gateway must have already staked ARIO tokens and joined the network before it starts. -- Each epoch (approximately 7 block-days), a random pool of active gateways will be selected (prescribed) to perform observation duties. +- Each epoch (approximately 7 days), a random pool of active gateways will be selected (prescribed) to perform observation duties. - Within the epoch, observers are tasked with evaluating a subset of ArNS names for each gateway in the network. - By the end of the epoch’s observation reporting period, the observer must upload its standardized health observation report to Arweave. - The observer must also submit an interaction to the AR.IO contract to save its report transaction ID and a summary of all failed gateways for tallying by the incentive protocol. @@ -39,11 +39,11 @@ The to-be-evaluated ArNS names include a set of names randomly determined by the Each observer shall assess the performance of the selected ArNS names (across all gateways) and summarize those findings in a report which details the following: -- General Information: Observer's Arweave address, starting and concluding block heights for the epoch. +- General Information: Observer's Arweave address, starting and concluding timestamps for the epoch. - Gateway Operator Assessment: The expected and actual Arweave addresses of observed gateways, along with a summary verdict (pass or fail), and accompanying reasons for failure. -- Detailed ArNS Evaluations: For each gateway, it includes the domain name, evaluated ArNS names, the associated block height, transaction IDs, data hashes, a "pass or fail" score, reasons for failure (if any), and performance metrics like time to the first byte. +- Detailed ArNS Evaluations: For each gateway, it includes the domain name, evaluated ArNS names, the associated timestamp, transaction IDs, data hashes, a "pass or fail" score, reasons for failure (if any), and performance metrics like time to the first byte. A comprehensive list of report criteria can be found in the Appendix. @@ -61,7 +61,7 @@ The weighted selection criteria will consider the following for each gateway: - Stake Weight (SW): This factor considers how financially committed a gateway is to the network. It is the ratio of the amount of ARIO tokens staked by the gateway relative to the network minimum and is expressed as SW = Gateway Stake / Minimum Stake. -- Tenure Weight (TW): This factor considers how long a gateway has been part of the network, with a maximum value capped at 4. It is calculated as TW = Gateway Network Tenure / 6 block-months. This means that the maximum value is achieved after 2 block-years of participation in the network. +- Tenure Weight (TW): This factor considers how long a gateway has been part of the network, with a maximum value capped at 4. It is calculated as TW = Gateway Network Tenure / 6 months. This means that the maximum value is achieved after 2 years of participation in the network. - Gateway Reward Ratio Weight (GRRW): This factor is a proxy for a gateway’s performance at resolving ArNS names. The weight represents the ratio of epochs in which a gateway received rewards for correctly resolving names relative to their total time on the network. @@ -140,8 +140,8 @@ Each observer shall assess the performance of the selected ArNS names (across al ## General Information - The observer's Arweave address. -- The starting block height of the epoch. -- The block height at which the report was generated. +- The starting timestamp of the epoch. +- The timestamp at which the report was generated. ## Overall Gateway Operator Assessment @@ -154,7 +154,7 @@ Each observer shall assess the performance of the selected ArNS names (across al ## ArNS Assessments - Observed ArNS name (for all prescribed and chosen names). -- The block height at which the name was assessed. +- The timestamp at which the name was assessed. - The expected status code. - The resolved status code. - The transaction ID that the observer expects the associated name to resolve to. diff --git a/docs/src/gateways/ar-io-node/testnet.md b/docs/src/gateways/ar-io-node/testnet.md index 0ff0d5c0..b2a67250 100644 --- a/docs/src/gateways/ar-io-node/testnet.md +++ b/docs/src/gateways/ar-io-node/testnet.md @@ -15,13 +15,13 @@ tags: [testnet, join, application, jwk, qty, fqdn, label, note, properties] 2. Gateway must be associated with an Arweave Wallet. - Learn about creating Arweave wallets [here](https://ar.io/wallet) -3. Arweave wallet must be funded with enough AR tokens to pay for transaction gas. +3. Arweave wallet must be funded with enough [ARIO tokens](https://ar.io/test-ario) to meet the minimum stake for gateway operators. -## Submit an Application + +New applications for joining the Testnet are not currently being accepted. Be sure to join the [ar.io Discord](https://discord.com/invite/7zUPfN4D6g) to stay up to date on Testnet status and possible future availability prior to the launch of the Mainnet. --> -->