Documentation

Git Clone

  • Clone git repo by admin to respective user system

To do

  • For images, create the folder name as images in the folder
  • Files and folder name should be small letter and separated with hyphen (-)
  • Images path will be start from images/\<relative path>
  • Make sure in the folder doc-gen folder should be there. In that folder, below files should be there
    • custom-config.js
    • custom-script.js
    • custom-sidebar.js
    • custom-style.css

Mark Down

  • For title of the page, add title at the top of the page in between two ---

    MD TITLE

  • Don't use # for the heading

  • Right side navigation bar(In side page navigation) will be auto created based on ## and ### used in the page

  • All markdown syntax can be use in the file MD File

  • Use HTML table for the table content

  • Always preview in vs code to check the format

Add landing page

  • Open custom-config.js file in doc-gen folder

  • Add landing page relative path in customFields -> landingDocId

    LANDING PAGE

Add Left side navigation bar

  • This navigation bar is used to navigate from one file to other file
  • Add file details in custom-sidebar.js
  • In add custom-sidebar.js details in someSidebar

Add collapsible title

  • For collapsible title, we need 3 things,

    • type: Type should be category

    • label: Label should be display in navigation bar

    • items: Items should be an array, which contain child item(s) of the collapsible title.

    • In side items, we can add document or nested collapsible things

      COLLAPSIBLE TITLE

Add file and path

  • To add file in sidebar, we need 2 things,
    • type: Type should be doc
    • id: Id should be relative path of the md file

Commit Changes

Test

  • It will take 40 min to apply build after commit

  • We will get notification in teams in respective chanel

  • If build apply successfully, we will get success message

    BUILD SUCCESS

  • If build fail, we will get failed message with log file link

    BUILD FAIL

  • Click on highlighted link

  • It will redirect to browser and will display the error

    BUILD ERROR

  • Fix the error, commit, test till error fixed

  • If error is not understandable, contact to respective