-
Notifications
You must be signed in to change notification settings - Fork 416
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
Fix #10778 Dev guide, JSDoc and migration documentation for the new homepage plugins #10814
Conversation
…n for the new homepage plugins
There was a problem hiding this 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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good.
- We need to document the new script here:
- When I ran
npm run jsdoc:update
I have some changes ondocma-config.json
. I expected it was already updted. Could you check?
…into issue_10778
…into issue_10778
…into issue_10778
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)
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)
Other useful information