Skip to content

Commit 9439b41

Browse files
authored
Maintenance updates docs (#176)
* Revisit link checker, update broken link * Update api3-docs name * Update ignore files * Avoid search suggestions from ignored files * Revert "Update ignore files" This reverts commit 56e65d6. * Avoid vitepress-docs reference
1 parent 3a69ab2 commit 9439b41

File tree

6 files changed

+8
-10
lines changed

6 files changed

+8
-10
lines changed

.vscode/settings.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,5 @@
8383
],
8484
"editor.defaultFormatter": "esbenp.prettier-vscode",
8585
"editor.formatOnSave": true,
86-
"search.useIgnoreFiles": false,
8786
"editor.rulers": [80]
8887
}

docs/.vitepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export default {
7272
},
7373
siteTitle: 'Documentation',
7474
socialLinks: [
75-
{ icon: 'github', link: 'https://github.com/api3dao/oev-docs' },
75+
{ icon: 'github', link: 'https://github.com/api3dao/api3-docs' },
7676
{
7777
icon: 'discord',
7878
link: 'https://discord.gg/api3dao',

docs/dapps/integration/security-considerations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Like all smart contracts, Api3ReaderProxyV1 carries this inherent risk.
2424

2525
We propose three methods to assess the smart contract risk.
2626
You can refer to the related [audit reports.](https://github.com/api3dao/contracts?tab=readme-ov-file#security)
27-
A more practical approach is to refer to [our historical TVS](https://defillama.com/oracles/API3) to understand the _battle-testedness_ of our data feeds.
27+
A more practical approach is to refer to [our historical TVS](https://defillama.com/oracles/Api3) to understand the _battle-testedness_ of our data feeds.
2828
Additionally, you are welcome to review the contracts behind [Api3ReaderProxyV1](/dapps/integration/contract-integration.md#api3readerproxyv1), specifically [Api3ServerV1](https://github.com/api3dao/contracts/blob/main/contracts/api3-server-v1/Api3ServerV1.sol) and [Api3ServerV1OevExtension](https://github.com/api3dao/contracts/blob/main/contracts/api3-server-v1/Api3ServerV1OevExtension.sol).
2929
Our [contract developer docs](https://github.com/api3dao/contracts/tree/main/docs) provide additional context for understanding the design decisions behind these contracts.
3030

firebase-deploy.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ cd docs/.vitepress/dist
1919
# if you are deploying to a custom domain
2020
# echo 'www.example.com' > CNAME
2121

22-
# Use this section if you want to push to a depoyment branch.
23-
# api3dao/vitepress-docs uses the main branch as default.
22+
# Use this section if you want to push to a deployment branch.
23+
# api3dao/api3-docs uses the main branch as default.
2424
# git init must start with a main branch so firebase-pages will
2525
# "hang" off of it.
2626
# git init --initial-branch=main
@@ -32,7 +32,7 @@ cd docs/.vitepress/dist
3232

3333
# If you are deploying to https://<USERNAME>.github.io/<REPO>
3434
# NEVER push to main, use main:firebase-pages.
35-
# git push -f git@github.com:wkande/vitepress-docs.git main:firebase-pages
35+
# git push -f git@github.com:wkande/api3-docs.git main:firebase-pages
3636

3737
cd -
3838

libs/link-validator-ignore.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
[
22
"https://basescan.org",
3-
"https://defillama.com/oracles/API3",
3+
"https://defillama.com/oracles/Api3",
44
"https://etherscan.io",
5-
"https://github.com/api3dao/oev-docs",
6-
"https://github.com/api3dao/oev-v1-compound-bot",
5+
"https://medium.com/api3/oracle-extractable-value-oev-13c1b6d53c5b",
76
"https://oev.rpc.api3.org",
87
"https://orbitlending.io/",
98
"https://www.coinbase.com/blog/introducing-the-coinbase-price-oracle",

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "oev-docs",
2+
"name": "api3-docs",
33
"version": "1.0.0",
44
"main": "index.js",
55
"license": "MIT",

0 commit comments

Comments
 (0)