-
Notifications
You must be signed in to change notification settings - Fork 3
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
Integration with Doc Prop #96
base: master
Are you sure you want to change the base?
Conversation
Hi! I'm VTEX IO CI/CD Bot and I'll be helping you to publish your app! 🤖 Please select which version do you want to release:
And then you just need to merge your PR when you are ready! There is no need to create a release commit/tag.
|
Beep boop 🤖 Thank you so much for keeping our documentation up-to-date ❤️ |
@juliarocha can you comment here some workspaces with your contributions. Examples with and without docprop, please? |
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.
The code looks good to me, but please provide a way for us to test it :)
Also, please fix the linting issues pointed out by GitHub. A yarn lint --fix
might be enough.
Looking good. I would only fix the minor lint issues and put |
What did you change? *
Added integration with Doc Prop via markdown placeholder.
Why? *
Keeping the Store Components documentation up to date with the code and independent from manual documentation.
How to test it? *
Doc Prop working on some components:
https://juzon--appliancetheme.myvtex.com/docs/app/[email protected]/
https://juzon--appliancetheme.myvtex.com/docs/app/[email protected]/ (beta version - migration in PR)
Components without Doc Prop:
https://juzon--appliancetheme.myvtex.com/docs/app/vtex.flex-layout
https://juzon--appliancetheme.myvtex.com/docs/app/vtex.rich-text (current version)
Types of changes *