Skip to content

Latest commit

 

History

History
103 lines (69 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

103 lines (69 loc) · 2.86 KB
Raw

Contributor's Guide

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, 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.

Pre-requisites

  • Node.js (version 20 or higher).
  • Unix/macOS/WSL for the scripts to work properly.

Installation

pnpm install

Running the local development server

Run the following command to start the local development server on port 5173:

pnpm docs:dev

Structure

The API3 Docs repository is structured as follows:

  • /docs/explore: Explore section within the API3 Docs.
  • /docs/guides: All the guides that demonstrate the use of Airnode, QRNG and dAPIs.
  • /docs/reference: Contains the core documentation for Airnode, QRNG and dAPIs.

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 for more info about the structure of the docs.

Building the static site

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:

pnpm format

Formatting and Styling

You can use markdown to format the content. Check out the docs development section for more info. Some useful links:

Git Workflow:

Check this out 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 for a bug.
  • Submit an issue for a feature request.
  • Submit an issue for a documentation request.

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.