fix: docs format

[kobenguyent]

Motivation/Description of the PR

• Due to the lib that we are using to generate docs, the fast and cheap way to fix those format issue is moving the texts to above the mustache template.

Type of change

• 📋 Documentation changes/updates
• 🔨 Markdown files fix - not related to source code

Checklist:

• Documentation has been added (Run npm run docs)

[kobenguyent]

FYI: @Horsty80 @elbotho as you are currently touching the fix for documentation.

updated the contribution guide: https://github.com/codeceptjs/CodeceptJS/blob/3.x/.github/CONTRIBUTING.md#documentation

[Horsty80]

FYI: @Horsty80 @elbotho as you are currently touching the fix for documentation.

updated the contribution guide: https://github.com/codeceptjs/CodeceptJS/blob/3.x/.github/CONTRIBUTING.md#documentation

Oh ! You are right i didnt check existing PR before doing mine ^^’

just one question, what is the purpose of the npm docs command that you mention ?
The doc isn’t just the md files ?

[kobenguyent]

well, I'm not sure if that's correct, but per my best knowledge, docs that we see on website https://codecept.io/ are involving multiple steps.

Long story short : After you updated docblock in JS file, generate markdown files with next command:
npm run docs

[elbotho]

@kobenguyent thank you! I'm glad that this approach does not mess with the titles (as I would have expected).