Velaptor Documentation Website

Hello!! This repository is for the documentation website for Velaptor and contains the Velaptor API documentation as well as tutorials.

How to Contribute

This website is built using Docusaurus 2, a modern static website generator. Please refer to the original Docusaurus Documentation to learn about how it works and how to get started.

Below are simple steps you will need when contributing.

Fork the repository
Create a feature branch with the syntax feature/<issue-number>-<branch-description>.

Example feature/123-my-branch

Note Feature branches are created from master and are merged back into master.
Start and Early Pull Requests with the first empty commit with the value Start work for issue #<issue-number>.

Note Create the pull request in draft please. 😀
Perform your work. Make sure to test locally!!
Take the PR out of draft which will request a review.

Note Let a maintainer know that it is ready for review!

Common Development Commands

Install npm packages

yarn

Local Development Server

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Run Build Locally

yarn serve