From aa11596c548c6b9ec8775b53081f5a260b62bc47 Mon Sep 17 00:00:00 2001 From: Derek Croote Date: Sun, 13 Aug 2023 23:28:47 -0700 Subject: [PATCH] fix: broken links, language, capitalization --- .../nav-boxes/nav-boxes-guides.json | 2 +- .../airnode/unlocking-real-world-data.md | 2 +- docs/explore/dapis/using-dapis.md | 6 +++--- docs/explore/dapis/what-are-dapis.md | 20 +++++++++---------- .../introduction/decentralized-apis.md | 4 ++-- .../funding-multiple-dapis-gelato/index.md | 6 +++--- .../dapis/subscribing-managed-dapis/index.md | 20 +++++++++---------- .../subscribing-self-funded-dapis/index.md | 2 +- docs/reference/dapis/understand/index.md | 4 ++-- docs/reference/dapis/understand/iproxy.md | 4 ++-- docs/reference/dapis/understand/managed.md | 16 +++++++-------- .../dapis/understand/proxy-contracts.md | 4 ++-- docs/reference/dapis/understand/read-dapis.md | 3 +-- .../reference/dapis/understand/self-funded.md | 20 +++++++++---------- 14 files changed, 56 insertions(+), 57 deletions(-) diff --git a/docs/.vitepress/nav-boxes/nav-boxes-guides.json b/docs/.vitepress/nav-boxes/nav-boxes-guides.json index df66ad1c..f1a36f95 100644 --- a/docs/.vitepress/nav-boxes/nav-boxes-guides.json +++ b/docs/.vitepress/nav-boxes/nav-boxes-guides.json @@ -5,7 +5,7 @@ "content": "Use the API3 Market and obtain access to self-funded dAPIs." }, "_read-dapi-proxy": { - "btnURL": "/guides/dapis/read-self-funded-dapi/", + "btnURL": "/guides/dapis/read-a-dapi/", "title": "Reading a dAPI", "content": "Use a proxy contract to call a dAPI." }, diff --git a/docs/explore/airnode/unlocking-real-world-data.md b/docs/explore/airnode/unlocking-real-world-data.md index e42014be..ac62251f 100644 --- a/docs/explore/airnode/unlocking-real-world-data.md +++ b/docs/explore/airnode/unlocking-real-world-data.md @@ -156,7 +156,7 @@ needs to be compatible with an oracle node. ::: info Read more This functionality includes functions such as -[Authorizers](/reference/airnode/latest/understand/apply-auth.html). An Airnode +[Authorizers](/reference/airnode/latest/understand/apply-auth.md). An Airnode can authorize smart contracts (know as requesters) access to its endpoints using Authorizers. diff --git a/docs/explore/dapis/using-dapis.md b/docs/explore/dapis/using-dapis.md index 5e36f544..c944dbb6 100644 --- a/docs/explore/dapis/using-dapis.md +++ b/docs/explore/dapis/using-dapis.md @@ -52,7 +52,7 @@ already been funded and any dApp owner can proceed to use the dAPI. @@ -71,7 +71,7 @@ dAPIs. To use a self-funded data feed you: - [Fund a sponsor wallet](/guides/dapis/subscribing-self-funded-dapis/) (if not already funded) - Deploy the proxy contract (if not already deployed) -- [Read the dAPI](/guides/dapis/read-self-funded-dapi/) +- [Read the dAPI](/guides/dapis/read-a-dapi/) @@ -83,7 +83,7 @@ a [proxy contract](/reference/dapis/understand/proxy-contracts.md). ::: info Get started Developers can use the API3 Market now to -[read](/guides/dapis/read-self-funded-dapi/) +[read](/guides/dapis/read-a-dapi/) a self-funded dAPI. ::: diff --git a/docs/explore/dapis/what-are-dapis.md b/docs/explore/dapis/what-are-dapis.md index 72c78a78..2012c666 100644 --- a/docs/explore/dapis/what-are-dapis.md +++ b/docs/explore/dapis/what-are-dapis.md @@ -37,13 +37,13 @@ or a set of beacons and are sometimes referred to as first-party data feeds because they are sourced from first-party oracles. Therefore a beacon is directly powered and maintained on-chain by the owner of the data, the API provider, which effectively removes third-party middlemen that other oracle -solutions rely on. This approach creates source transparency in addition to, -higher security, cost-efficiency and scalability through less parties being +solutions rely on. This approach creates source transparency in addition to +higher security, cost-efficiency, and scalability through less parties being involved in the oracle service operation. ## dAPIs connect smart contracts to first-party data feeds -Through the use of the proxy contract function `read()` API3 can associate the +Through the use of the proxy contract function `read()`, API3 can associate the ID of a beacon or beacon set with a human-readable name like ETH/USD. The benefit of this approach is that dApps continue to read the same dAPI name without being required to make any changes to their code, effectively turning @@ -55,8 +55,8 @@ At the core, a **dAPI** is a mapping that points towards a **beacon** or a **beacon set**, similarly to how an ENS name is mapped to a wallet address. The ability to control this mapping allows the API3 DAO to take over the management overhead that is associated with oracle infrastructure by e.g. creating a new -beacon set if one first-party oracle becomes unavailable and pointing the name -"AVAX/USD" towards the newly created ID. +beacon set if one first-party oracle becomes unavailable and pointing the name, +e.g. `AVAX/USD`, towards the newly created ID. ## What is a Beacon or a Beacon Set? @@ -143,7 +143,7 @@ A dAPI points to an individual beacon or an aggregation of multiple beacons (beacon set). Each dAPI has a human-readable name (e.g., `AVAX/USD`) that makes them easy to categorize. The contract [API3ServerV1.sol](/reference/dapis/understand/) maintains the link between a -dAPI name and the beacon(s) it uses for the dAPI. dApps use an API3 Marker proxy +dAPI name and the beacon(s) it uses for the dAPI. dApps use an API3 Market proxy contract to read any dAPI from `API3ServerV1.sol`. dApp owners use a proxy contract, available on the @@ -159,8 +159,8 @@ The `API3ServerV1.sol` contract reads directly from its data store of beacons, which are powered by API provider-operated [Airnodes](/reference/airnode/latest/). Thus proxies allow dAPIs to be used like libraries. The smart contract only needs to -[import the interface](/guides/dapis/read-self-funded-dapi/) for calling the -proxy contract. +[import the interface](/guides/dapis/read-a-dapi/index.md#2-read-a-dapi) for +calling the proxy contract. This means once a dAPI is integrated to read a different data feed, the contract does not need to change the code itself, rather it only needs to use a different @@ -172,9 +172,9 @@ Refer to these guides and learn how to fund a self-funded dAPI and to read the dAPI using a proxy contract: - [Subscribing to Self-Funded dAPIs](/guides/dapis/subscribing-self-funded-dapis/index.md) -- [Reading a Self-Funded dAPI Proxy](/guides/dapis/read-self-funded-dapi/index.md) +- [Reading a Self-Funded dAPI Proxy](/guides/dapis/read-a-dapi/) -