Skip to main content

Product Documentation

ℹ️ Overview​

Product documentation is maintained using Markdown within an open source documentation application called Docusaurus. This is the standard mechanism for all product documentation within Rizing.

RECOMMENDATION

Familiarize yourself with Docusaurus and Rizing's documentation style guide before getting started.

✏️ Contributing​

🚀 Quick Start​

If your environment is already setup:

git clone https://rizing-devops@dev.azure.com/rizing-devops/rizing/_git/monorepo
cd monorepo
npm install
tip

See Cloning a Repository docs for help on cloning a repository for the first time in ADO.

Run the docs locally:

npm run start:YOUR_PRODUCT:docs
# Example npm run start:dev-guide:docs
# A browser window will popup with your docs running at http://localhost:3000

💿 Environment Setup​

Dependencies​

The following dependencies are necessary to be installed on your machine:

NodeJS (NVM) Setup​

tip

It's highly recommended to use Node Version Manager (nvm), rather than directly installing a version of NodeJS. This will allow you to effortlessly install and switch between NodeJS versions.

Download and install one of the following:

Install NodeJS >= 20.10.0

# Install NodeJS version
nvm install 20

# Set as active version
nvm use 20

Clone Repository​

git clone https://rizing-devops@dev.azure.com/rizing-devops/rizing/_git/monorepo
note

Generate a Personal Access Token in Azure DevOps if necessary.

Open Code​

  1. Open the root folder in Visual Studio Code (or other IDE if preferred)
  2. When prompted from Visual Studio Code to install the recommended extensions, click "Yes"
  3. Install NodeJS packages (npm install)

Structure​

The repository has the following structure:

📦 monorepo            # repo root
 ┣ 📂 apps             # contains all NodeJS apps
 ┃ ┣ 📂 app1
 ┃ ┣ 📂 app2
 ┃ ┗ 📂 app3
 ┣ 📂 docs             # contains all application documentation (using Docusaurus)
 ┃ ┣ 📂 app1
 ┃ ┣ 📂 app2
 ┃ ┣ 📂 app3
 ┃ ┗ 📂 dev-guide      # developer guide docs
 ┗ 📂 libs             # re-usable library code, broken down into packages (libs)
   ┣ 📂 lib1
   ┣ 📂 lib2
   ┗ 📂 storybook-host # storybook server that pulls all stories from all libs