Skip to content

fix: docs format - #4076

Merged
kobenguyent merged 2 commits into
3.xfrom
fix-playwright-docs
Dec 19, 2023
Merged

fix: docs format#4076
kobenguyent merged 2 commits into
3.xfrom
fix-playwright-docs

Conversation

@kobenguyent

Copy link
Copy Markdown
Collaborator

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

kobenguyent commented Dec 17, 2023

Copy link
Copy Markdown
Collaborator Author

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

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Collaborator Author

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

elbotho commented Dec 17, 2023

Copy link
Copy Markdown

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

@kobenguyent
kobenguyent merged commit 6c57921 into 3.x Dec 19, 2023
@kobenguyent
kobenguyent deleted the fix-playwright-docs branch December 19, 2023 05:19
@kobenguyent kobenguyent mentioned this pull request Jan 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants