diff --git a/src/command-configs/help/parts/hero.pug b/src/command-configs/help/parts/hero.pug index 77f0bb0..5e2306b 100644 --- a/src/command-configs/help/parts/hero.pug +++ b/src/command-configs/help/parts/hero.pug @@ -3,13 +3,14 @@ div.ms-hero.mb-lg h1.ms-hero-title Command Bot - Help Docs div.ms-hero-content p - | Based on + | Based on  a(href=repoLink) #{repoLink} p rev: #{scriptsRevision} - p running custom commands, like: + p Running custom commands, like: br code #{commandStart} command-name -v VAR=value id --argument=1 --argument=2 br + br | Or even multiple commands in one comment: br code #{commandStart} clean @@ -17,11 +18,11 @@ div.ms-hero.mb-lg code #{commandStart} command-name --argument=2 br code #{commandStart} command-name --argument=3 - p To add new command:   - ul - li go to + p To add a new command:   + ol + li Go to  a(href=config.pipelineScripts.repository) #{config.pipelineScripts.repository} - li add new command and open PR - li read   - a(href="\#link-new-command") how to test new command before merging - li merge. Then after merge PR, it accessible without branch override + li Add new command and open a PR. + li Read  + a(href="\#link-new-command") how to test the new command before merging. + li Merge. Then after merging the PR, it will be accessible without branch override. diff --git a/src/command-configs/renderHelpPage.ts b/src/command-configs/renderHelpPage.ts index 7e9e7d9..31af60b 100644 --- a/src/command-configs/renderHelpPage.ts +++ b/src/command-configs/renderHelpPage.ts @@ -47,8 +47,8 @@ function prepareConfigs(cmdConfigs: CommandConfigs): CommandConfigs { const newCmdConfigs: CommandConfigs = {}; // these commands are added here, as they are defined inside of bot - newCmdConfigs.help = mockStaticConfig("Generates help page & provides a link"); - newCmdConfigs.clean = mockStaticConfig("Clears bot comments in PR"); + newCmdConfigs.help = mockStaticConfig("Generates the help page & provides a link."); + newCmdConfigs.clean = mockStaticConfig("Clears bot comments in the PR."); // clean up excluded for (const cmdName in cmdConfigs) {