Skip to content

29next/developer-docs

Repository files navigation

Logo

29 Next Developer Docs

29 Next's developer documentation portal, built with Docusaurus and Stoplight.
Explore the Docs »

Built With

Getting Started

This section describes how you can get our documentation portal up and running on your machine.

Prerequisites

Installation

Clone the repo

git clone git@github.com:29next/developer-docs.git

Install NPM packages

npm install

Run the app

npm start

Update API Docs

API Reference docs for Admin API and Campaigns API use Open API Spec files downloaded from their respective apps.

Update Script

Included in the docs is a python script to automatically fetch the latest versions of the Open API Spec files and update them for the developer docs portal usage.

Install Dependenceis

virtualenv venv
source venv/bin/activate
pip install -r requirements.txt

Run Update

cd tools/
python update_api_docs.py