Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #10778 Dev guide, JSDoc and migration documentation for the new homepage plugins #10814

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

allyoucanmap
Copy link
Contributor

Description

This PR includes JSDoc and migration guidelines for the new hompage plugins.
It includes also a script to update the docma-config.json for msApi and plugins sections, new command added to package.json is:

npm run jsdoc:update

Please check if the PR fulfills these requirements

What kind of change does this PR introduce? (check one with "x", remove the others)

  • Developer Guide

Issue

What is the current behavior?

#10778

What is the new behavior?

JSDoc and migration guidelines for the new hompage plugins

Breaking change

Does this PR introduce a breaking change? (check one with "x", remove the other)

  • No

Other useful information

Copy link
Member

@tdipisa tdipisa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@allyoucanmap great job! In my opinion it would be good to have a kind of validator at build time to check if the docma-config file is updated throwing a warning if necessary by making the app build to fail. This way we can be aware over time if something is missing.

@allyoucanmap
Copy link
Contributor Author

@tdipisa I included a new npm run jsdoc:check that runs just before the jsdoc build (cde6ab0)

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.

Dev guide, JSDoc and migration documentation for the new homepage plugins
2 participants