docs: update docs about documenting props, slots and events

What does this MR do?

This updates the documentation that explains how components' API can be documented. While we previously relied on the .documentation.js file for this, we can now leverage code comments that are parsed by vue-docgen and rendered as props tables inside Storybook's docs pages.