Skip to content

Commit bf3b358

Browse files
authored
fix: rename vitepress-docs to airnode-docs (#874)
Except in regards to firebase and the firebase-hosted URL
1 parent bf5e030 commit bf3b358

12 files changed

Lines changed: 34 additions & 33 deletions

File tree

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
1-
# API3 Technical Documentation
1+
# API3 Airnode Technical Documentation
22

3-
The technical documentation is maintained by the core technical team. Please
4-
feel free to create [issues](https://github.com/api3dao/vitepress-docs/issues)
5-
for discussions, proposals, additions, and changes in the repo `vitepress-docs`.
3+
The Airnode technical documentation is maintained by the core technical team.
4+
Please feel free to create
5+
[issues](https://github.com/api3dao/airnode-docs/issues) for discussions,
6+
proposals, additions, and changes in the repo `airnode-docs`.
67

78
## VitePress
89

910
The technical documentation has moved from
1011
[VuePress](https://vuepress.vuejs.org) to
1112
[VitePress](https://vitepress.vuejs.org).
1213

13-
- `vitepress-docs`: uses VitePress
14-
- `api3-docs`: uses VuePress
14+
- `airnode-docs`: uses VitePress
15+
- `old-api3-docs`: uses VuePress
1516

1617
## Firebase
1718

18-
Firebase is used to host the `vitepress-docs` technical documentation.
19+
Firebase is used to host the `airnode-docs` technical documentation.
1920

2021
### Production
2122

22-
- DNS: https://docs.api3.org
23+
- DNS: https://airnode-docs.api3.org
2324
- Hosted with Firebase: https://vitepress-docs.web.app
2425

2526
### Previews
@@ -42,6 +43,6 @@ https://old-docs.api3.org and is still hosted using `gh-pages`.
4243

4344
## /dev/ docset
4445

45-
Use https://docs.api3.org/dev/ to learn more about how the `vitepress-docs`
46+
Use https://docs.api3.org/dev/ to learn more about how the `airnode-docs`
4647
documentation is managed. For the legacy documentation use
4748
https://old-docs.api3.org/dev/.

docs/.vitepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export default {
4949
},
5050
siteTitle: 'Documentation',
5151
socialLinks: [
52-
{ icon: 'github', link: 'https://github.com/api3dao/vitepress-docs' },
52+
{ icon: 'github', link: 'https://github.com/api3dao/airnode-docs' },
5353
{
5454
icon: 'discord',
5555
link: 'https://discord.com/channels/758003776174030948/765618225144266793',

docs/_components/search/SearchBtn.vue

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -193,16 +193,16 @@ export default {
193193
reg = await axios.get(`/indexes/${name}/reg.json`);
194194
} else {
195195
cfg = await axios.get(
196-
`https://raw.githubusercontent.com/api3dao/vitepress-docs/main/docs/public/indexes/${name}/cfg.json`
196+
`https://raw.githubusercontent.com/api3dao/airnode-docs/main/docs/public/indexes/${name}/cfg.json`
197197
);
198198
ctx = await axios.get(
199-
`https://raw.githubusercontent.com/api3dao/vitepress-docs/main/docs/public/indexes/${name}/ctx.json`
199+
`https://raw.githubusercontent.com/api3dao/airnode-docs/main/docs/public/indexes/${name}/ctx.json`
200200
);
201201
map = await axios.get(
202-
`https://raw.githubusercontent.com/api3dao/vitepress-docs/main/docs/public/indexes/${name}/map.json`
202+
`https://raw.githubusercontent.com/api3dao/airnode-docs/main/docs/public/indexes/${name}/map.json`
203203
);
204204
reg = await axios.get(
205-
`https://raw.githubusercontent.com/api3dao/vitepress-docs/main/docs/public/indexes/${name}/reg.json`
205+
`https://raw.githubusercontent.com/api3dao/airnode-docs/main/docs/public/indexes/${name}/reg.json`
206206
);
207207
}
208208

docs/dev/axios-scripts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ tags:
1313
# {{$frontmatter.title}}
1414

1515
The script
16-
[axiosBuildScripts.js](https://github.com/api3dao/vitepress-docs/blob/main/libs/axiosBuildScripts.js)
16+
[axiosBuildScripts.js](https://github.com/api3dao/airnode-docs/blob/main/libs/axiosBuildScripts.js)
1717
is used to generated local data files. These files are rendered by certain
1818
markdown pages as a data source. For example see these markdown files:
1919

20-
- [/reference/dapis/chains/chains-list.md](https://raw.githubusercontent.com/api3dao/vitepress-docs/main/docs/reference/dapis/chains/chains-list.md)
21-
- [/reference/airnode/latest/index.md](https://raw.githubusercontent.com/api3dao/vitepress-docs/main/docs/reference/airnode/latest/index.md)
20+
- [/reference/dapis/chains/chains-list.md](https://raw.githubusercontent.com/api3dao/airnode-docs/main/docs/reference/dapis/chains/chains-list.md)
21+
- [/reference/airnode/latest/index.md](https://raw.githubusercontent.com/api3dao/airnode-docs/main/docs/reference/airnode/latest/index.md)
2222

2323
The local data files provide for a better page load experience rather than
2424
real-time data access from the monorepo. More importantly, the local data files

docs/dev/containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ tags:
1313
# {{$frontmatter.title}}
1414

1515
VitePress provides several containers. The following examples explain how they
16-
should be used in `vitepress-docs`.
16+
should be used in `airnode-docs`.
1717

1818
::: info
1919

docs/dev/firebase.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ tags:
1414

1515
All production and PR preview deployments are published on Firebase hosting and
1616
are built automatically using GitHub
17-
[workflows](https://github.com/api3dao/vitepress-docs/tree/main/.github/workflows)
18-
stored in the `vitepress-docs` repo.
17+
[workflows](https://github.com/api3dao/airnode-docs/tree/main/.github/workflows)
18+
stored in the `airnode-docs` repo.
1919

20-
- Production: https://vitepress-docs.web.app (and https://docs.api3.org)
20+
- Production: https://vitepress-docs.web.app (and https://airnode-docs.api3.org)
2121

2222
## Repo Branches
2323

docs/dev/flexsearch.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ tags:
1414

1515
[FlexSearch](https://www.npmjs.com/package/flexsearch) is used to support
1616
searching in the docs. The script
17-
[/libs/flexBuildIndexes.js](https://github.com/api3dao/vitepress-docs/blob/main/libs/flexBuildIndexes.js)
17+
[/libs/flexBuildIndexes.js](https://github.com/api3dao/airnode-docs/blob/main/libs/flexBuildIndexes.js)
1818
will index all HTML files in the `/dist` folder for the following directories:
1919

2020
- `/dist/explore/`
@@ -56,11 +56,11 @@ their content is generated at runtime in the browser. For example: a component
5656
uses Axios to pull data from an API operation.
5757

5858
To overcome this short fall, the script
59-
[/axiosBuildScripts.js](https://github.com/api3dao/vitepress-docs/blob/main/libs/axiosBuildScripts.js)
59+
[/axiosBuildScripts.js](https://github.com/api3dao/airnode-docs/blob/main/libs/axiosBuildScripts.js)
6060
gathers on-line data into local data files for markdown pages to use. This
6161
allows for proper rendering of HTML at build time. A example of a markdown file
6262
that uses a locally generated data file is
63-
[chains-list.md](https://raw.githubusercontent.com/api3dao/vitepress-docs/main/docs/reference/dapis/chains/chains-list.md).
63+
[chains-list.md](https://raw.githubusercontent.com/api3dao/airnode-docs/main/docs/reference/dapis/chains/chains-list.md).
6464

6565
## Creating/updating the index files
6666

docs/dev/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Mac users (Apple silicon) should see the page
2020

2121
It is best to use nodejs `v20` which gives the best performance and is the
2222
engine described in the
23-
[<span style="color:rgb(16, 185, 129);">package.json</span>](https://github.com/api3dao/vitepress-docs/blob/main/package.json)
23+
[<span style="color:rgb(16, 185, 129);">package.json</span>](https://github.com/api3dao/airnode-docs/blob/main/package.json)
2424
file.
2525

2626
:::
@@ -30,8 +30,8 @@ file.
3030
Clone the remote repo and install it packages.
3131

3232
```sh
33-
git clone git@github.com:api3dao/vitepress-docs.git
34-
cd vitepress-docs
33+
git clone git@github.com:api3dao/airnode-docs.git
34+
cd airnode-docs
3535
pnpm install
3636
```
3737

docs/dev/rosetta.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ using your CLI with Rosetta deactivated.
2525

2626
It is best to use nodejs `v20` which gives the best performance and is the
2727
engine described in the
28-
[package.json](https://github.com/api3dao/vitepress-docs/blob/main/package.json)
28+
[package.json](https://github.com/api3dao/airnode-docs/blob/main/package.json)
2929
file.
3030

3131
:::
3232

3333
```sh
34-
failed to load config from /Users/warren/DEV/vitepress-docs/docs/.vitepress/config.js
34+
failed to load config from /Users/warren/DEV/airnode-docs/docs/.vitepress/config.js
3535
build error:
3636
Error:
3737
You installed esbuild for another platform than the one you're currently using.

docs/guides/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ tags:
1919
Each guide is a complete standalone step-by-step introduction to Airnode. For
2020
Airnode the guides work with the latest version of Airnode. If you have an idea
2121
for a guide that you wish was here, please create a
22-
[GitHub issue](https://github.com/api3dao/vitepress-docs). This will help us
22+
[GitHub issue](https://github.com/api3dao/airnode-docs). This will help us
2323
create a full and comprehensive list.
2424

2525
<FlexEndTag/>

0 commit comments

Comments
 (0)