Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
9 changes: 0 additions & 9 deletions .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,5 @@
"tabWidth": 2,
"trailingComma": "es5",
"useTabs": false,
"overrides": [
{
"files": "*.md",
"options": {
"parser": "markdown",
"proseWrap": "always"
}
}
],
"endOfLine": "lf"
}
39 changes: 11 additions & 28 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
## Contributor's Guide

Welcome to the API3 Documentation Repository. This guide will help you get
started with contributing to the API3 documentation.
Welcome to the API3 Documentation Repository. This guide will help you get started with contributing to the API3 documentation.

## How to get started

The API3 Docs uses [VitePress](https://vitepress.dev/), a Vue-powered static
site generator. Follow the steps below to get started.
The API3 Docs uses [VitePress](https://vitepress.dev/), a Vue-powered static site generator. Follow the steps below to get started.

Make sure to check out https://docs.api3.org/dev/ for more details and
information about getting started and making a contribution to the API3 Docs.
Make sure to check out https://docs.api3.org/dev/ for more details and information about getting started and making a contribution to the API3 Docs.

### Pre-requisites

Expand Down Expand Up @@ -38,13 +35,11 @@ The API3 Docs repository is structured as follows:
- `/docs/guides`: All the guides that demonstrate the use of Airnode.
- `/docs/reference`: Contains the core documentation for Airnode.

Each section will have a `sidebar.js` file that contains the sidebar structure
for that section.
Each section will have a `sidebar.js` file that contains the sidebar structure for that section.

`/_components`: Contains the custom vue components used in the API3 Docs.

[Check this out](https://docs.api3.org/dev/docsets.html) for more info about the
structure of the docs.
[Check this out](https://docs.api3.org/dev/docsets.html) for more info about the structure of the docs.

### Building the static site

Expand All @@ -54,36 +49,29 @@ pnpm docs:build

### Prettier Formatting

Make sure to run the following command before submitting a PR to format the
markdown. The Github action will check for prettier formatting:
Make sure to run the following command before submitting a PR to format the markdown. The Github action will check for prettier formatting:

```bash
pnpm format
```

### Formatting and Styling

You can use markdown to format the content. Check out the
[docs development section](https://docs.api3.org/dev/) for more info. Some
useful links:
You can use markdown to format the content. Check out the [docs development section](https://docs.api3.org/dev/) for more info. Some useful links:

- [Page styling](https://docs.api3.org/dev/page-styling.html)
- [Formatting guides](https://docs.api3.org/dev/guides-format.html)
- [VitePress Containers](https://docs.api3.org/dev/containers.html)

### Git Workflow:

- `main` branch: for the current live site
[docs.api3.org](https://docs.api3.org)
- `main` branch: for the current live site [docs.api3.org](https://docs.api3.org)

[Check this out](https://docs.api3.org/dev/firebase.html#repo-branches) for more
info about the branches.
[Check this out](https://docs.api3.org/dev/firebase.html#repo-branches) for more info about the branches.

### Submitting an Issue

You can submit an issue if you find any bugs or have any feature requests.
Please make sure to check if the issue already exists before submitting a new
one.
You can submit an issue if you find any bugs or have any feature requests. Please make sure to check if the issue already exists before submitting a new one.

You can:

Expand All @@ -93,9 +81,4 @@ You can:

### Making a PR

After making changes in a feature branch, submit a PR against the `main` branch.
Make sure to link the corresponding GitHub Issue in the PR description e.g.
`Closes #1`. You will be able to see the changes within a Firebase preview
deployment that is unique to the PR. The PR will be reviewed by the team and
merged into the `main` branch, which will result in the changes going live into
production.
After making changes in a feature branch, submit a PR against the `main` branch. Make sure to link the corresponding GitHub Issue in the PR description e.g. `Closes #1`. You will be able to see the changes within a Firebase preview deployment that is unique to the PR. The PR will be reviewed by the team and merged into the `main` branch, which will result in the changes going live into production.
22 changes: 6 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
# API3 Airnode Technical Documentation

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

## VitePress

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

- `airnode-docs`: uses VitePress
- `old-api3-docs`: uses VuePress
Expand All @@ -25,24 +20,19 @@ Firebase is used to host the `airnode-docs` technical documentation.

### Previews

Additionally each PR has its own Firebase preview site. The URL will be
available in the PR's comments.
Additionally each PR has its own Firebase preview site. The URL will be available in the PR's comments.

## Making a Contribution

Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a
contribution.
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a contribution.

## Legacy documentation

The original documentation for the repo `api3-docs` is now accessible via
https://old-docs.api3.org and is still hosted using `gh-pages`.
The original documentation for the repo `api3-docs` is now accessible via https://old-docs.api3.org and is still hosted using `gh-pages`.

- DNS: http://old-docs.api3.org
- Hosted with GitHub: https://api3dao.github.io/api3-docs

## /dev/ docset

Use https://docs.api3.org/dev/ to learn more about how the `airnode-docs`
documentation is managed. For the legacy documentation use
https://old-docs.api3.org/dev/.
Use https://docs.api3.org/dev/ to learn more about how the `airnode-docs` documentation is managed. For the legacy documentation use https://old-docs.api3.org/dev/.
14 changes: 3 additions & 11 deletions docs/dev/axios-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,16 @@ tags:

# {{$frontmatter.title}}

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

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

The local data files provide for a better page load experience rather than
real-time data access from the monorepo. More importantly, the local data files
allow the vite build to pre-render the html so that Flex can index its content,
see
[Vue components and Flex indexes](/dev/flexsearch.md#vue-components-and-flex-indexes).
The local data files provide for a better page load experience rather than real-time data access from the monorepo. More importantly, the local data files allow the vite build to pre-render the html so that Flex can index its content, see [Vue components and Flex indexes](/dev/flexsearch.md#vue-components-and-flex-indexes).

## Building the local data files

The local data files can be refreshed by running the
`/libs/axiosBuildScripts.js` script as follows:
The local data files can be refreshed by running the `/libs/axiosBuildScripts.js` script as follows:

```sh
pnpm axios:build
Expand Down
6 changes: 2 additions & 4 deletions docs/dev/containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ tags:

# {{$frontmatter.title}}

VitePress provides several containers. The following examples explain how they
should be used in `airnode-docs`.
VitePress provides several containers. The following examples explain how they should be used in `airnode-docs`.

::: info

Expand All @@ -35,8 +34,7 @@ Express to the reader not to do something.

::: danger

Rarely used. Expresses an important failure concern to the reader should they
fail to follow instructions.
Rarely used. Expresses an important failure concern to the reader should they fail to follow instructions.

:::

Expand Down
6 changes: 2 additions & 4 deletions docs/dev/docsets.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ tags:

# {{$frontmatter.title}}

A docset is a logically grouped set of pages. Every docset has a root folder.
The current docsets are as follows:
A docset is a logically grouped set of pages. Every docset has a root folder. The current docsets are as follows:

- Explore: `/explore/`
- Guides: `/guides`
Expand All @@ -30,5 +29,4 @@ The current docsets are as follows:
- DAO Members `/reference/dao-members/`
- Docs Development `/dev/`

For more information about `/latest` and `/next` see
[Airnode/OIS Versioning](/dev/versioning.md).
For more information about `/latest` and `/next` see [Airnode/OIS Versioning](/dev/versioning.md).
12 changes: 3 additions & 9 deletions docs/dev/firebase.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,17 @@ tags:

# {{$frontmatter.title}}

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

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

## Repo Branches

When a PR is merged into the default branch, `main`, a Firebase deployment of
the docs production website is triggered.
When a PR is merged into the default branch, `main`, a Firebase deployment of the docs production website is triggered.

## Firebase emulator

You can run the docs using the firebase emulator after updating the flex indexes
and prior to pushing changes to the repo. Run the following commands from the
root of the project after ensuring that the firebase CLI is installed.
You can run the docs using the firebase emulator after updating the flex indexes and prior to pushing changes to the repo. Run the following commands from the root of the project after ensuring that the firebase CLI is installed.

```sh
firebase:emulator
Expand Down
Loading
Loading