Video SDK Documentation
docs.videosdk.live

Website

This website is built using Docusaurus 2, a modern static website generator.

Built With

• Docusaurus
• React
• Tailwind

Getting Started

This section describes how you can setup our documentation on your machine.

Prerequisites

• node
• npm

Installation

1. Clone the repo

git clone https://github.com/videosdk-live/videosdk-docs.git

2. Install NPM packages

npm install

3. Run the app

npm run dev

Usage

Writing Documentation

To just edit older documentation, go to the specified versioned folder for a section, for example, you want to edit documentation for React SDK v0.25.x, open up react_versioned_docs/version-0.25.x and edit the required files there.

For updating documentation, go to specific SDK folder, for example, you want to change documentation for JS SDK so you have to open react_versioned_docs/version-0.25.x After opening this, you may seen below folder structure

   javascript_docs_versioned_docs/version-0.0.x
   ├── api
   │     ├── sdk-reference
   ├── guide
   │     ├── video-and-audio-calling-api-sdk
   .     .

If you want to modify the sdk-reference of JS SDK, you have to open up api/sdk-reference and make changes accordingly or want to modify the Guide of JS SDK, you have to open up guide/video-and-audio-calling-api-sdk and make changes accordingly.