docs: Change API docs template to jsdoc-clean-theme

[coratgerl]

Pull Request

• Report security issues confidentially.
• Any contribution is under this license.
• Link this pull request to an issue.

Issue

Closes: #8017

Approach

Modernize the API doc template with jdoc-clean-theme.

Tasks

• Add changes to documentation (guides, repository pages, code comments)

Changes

I had to fix some documentation to avoid duplicate Modules or duplicate class 🙂

Before :

After:

[parse-github-assistant]

I will reformat the title to use the proper commit message syntax.

[parse-github-assistant]

Thanks for opening this pull request!

[mtrezza]

Thanks for picking this up!

[codecov]

Codecov Report

Patch coverage has no change and project coverage change: -0.01 ⚠️

Comparison is base (177891e) 94.33% compared to head (7b0a6c3) 94.33%.

❗ Current head 7b0a6c3 differs from pull request most recent head 4e29c37. Consider uploading reports for the commit 4e29c37 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##            alpha    #8519      +/-   ##
==========================================
- Coverage   94.33%   94.33%   -0.01%     
==========================================
  Files         183      183              
  Lines       14515    14515              
==========================================
- Hits        13693    13692       -1     
- Misses        822      823       +1     

Impacted Files	Coverage Δ
src/Adapters/Analytics/AnalyticsAdapter.js	50.00% <ø> (ø)
src/Adapters/Cache/CacheAdapter.js	100.00% <ø> (ø)
src/Adapters/Email/MailAdapter.js	100.00% <ø> (ø)
src/Adapters/Files/FilesAdapter.js	100.00% <ø> (ø)
src/Adapters/Logger/LoggerAdapter.js	100.00% <ø> (ø)
src/Adapters/PubSub/PubSubAdapter.js	100.00% <ø> (ø)
src/Adapters/Push/PushAdapter.js	66.66% <ø> (ø)
src/Adapters/WebSocketServer/WSSAdapter.js	100.00% <ø> (ø)
src/Security/Check.js	100.00% <ø> (ø)
src/Security/CheckGroup.js	100.00% <ø> (ø)
... and 4 more

... and 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[coratgerl]

There are a lot of configurable options for jsdoc-clean-theme. We can customize it as you like :)

https://github.com/ankitskvmdam/clean-jsdoc-theme#options

[mtrezza]

Well, just the color scheme seems to be a bit off. The "Parse Blue" seems somewhat missing. Is there a way to configure colors?

[mtrezza]

Could you take a look at why the definitions check fails? You could run npm run definitions and see what files change.

[coratgerl]

Well, just the color scheme seems to be a bit off. The "Parse Blue" seems somewhat missing. Is there a way to configure colors?

I can add style to all html elements. I propose something like that :

[coratgerl]

Could you take a look at why the definitions check fails? You could run npm run definitions and see what files change.

I run : npm run definitions. It would not see any files change

[mtrezza]

The color changes in the screenshot above look good!

Could you post here what these changes are in the definition files? This PR shouldn't cause any changes there actually.

[coratgerl]

It's weird in local the npm run ci:definitionsCheck not fail. I don't see any change after the run definitions, just the files write by the prettier 🤔

[mtrezza]

Looks good! Definitions check passed this time, not sure why it failed previously.

Is this ready for merge?

[coratgerl]

It's ready for me :). Thanks for the feedbacks ;). You can also close this PR as long as you are the (same subject) #8021

[parseplatformorg]

🎉 This change has been released in version 6.1.0-alpha.8

[parseplatformorg]

🎉 This change has been released in version 6.1.0-beta.2

[parseplatformorg]

🎉 This change has been released in version 6.1.0