Steps for White labeling Bold BI help documentation

You can white label the Bold BI Help documentation, and you can use a custom logo and custom references for the documentation. Please find the repository details below

Repository Link: https://github.com/boldbi/bold-bi-docs/

This repository contains the “README.md” file, which contains the instructions for building and serving the application.

Follow the below steps for white labeling Bold BI documentation:

1. Change the favicon as per your logo in “\static\favicon.ico”.

   

2. Change the Bold BI Logo in the top left corner by replacing the “.svg” in “\src\assets\boldbi-logo.svg” with your logo, and then change the replaced file name in “\src\assets\css\index.css” file.

   

3. You can change or modify the required links in the top left corner in the “\src\components\Layout\Header.js” file

   

4. You can change or remove the copyright and powered by information present at the bottom of the documentation page. To achieve this, you can modify the “doc-footer” div element in “src\templates\layout.js” file and make the necessary style changes in “\src\assets\css\index.css” file.

   
   

5. You can customize the 404 Error page in “\static\404.html” and change the styles and logo in “\static\404\common”.

The REST API Reference files can be found in your cloned root folder’s api folder.

Follow the below steps to customize the REST API reference page:

All the swagger files and their necessary script, JSON, and styles are present in “\api\server-api-reference”. Here, you can find the files based on the available versions (v1.0, v2.0, v3.0, v4.0).

• The API reference page can be changed in “\api\server-api-reference\v1.0\api-reference”.
• Try it now page can be changed in “\api\server-api-reference\v1.0\ try-it-now”.