KTable docs small improvements

[MisRob]

Description

• Adds "Caption" usage section with brief guidance
  • Updates examples to reflect the guidance
• Rephrases some props usage for more clarity and conciseness, and removes duplicate information
• Removes unnecessary code comments

Issue addressed

Just noticed few places to improve as I was creating trivia.

Changelog

• Description: Smaller improvements of KTable documentation page
• Products impact: none
• Addresses: -
• Components: -
• Breaking: -
• Impacts a11y: -
• Guidance: -

Steps to test

Have a look at the preview build.

[MisRob]

Thank you, @BabyElias.

Just a doubt, the fact that we are encouraging users to put translated strings as captions for the table - is there any way that this can be shown or referenced in the docs here?

Ah yes good point. The thing is that KDS itself never handles translations, so I am not sure how to best communicate it in more explicit manner. Do you have any ideas?

[MisRob]

@BabyElias Thank you for review, addressed. If all looks well, can you approve?

[github-actions[bot]]

Percy Visual Test Results

Percy Dashboard: View Detailed Report

Environment:

• Node.js Version: 18.x
• OS: Ubuntu-latest

Instructions for Reviewers:

• Click on the Percy Dashboard link to view detailed visual diffs.
• Review the visual changes highlighted in the report.
• Approve or request changes based on the visual differences.

[MisRob]

Thanks for review @BabyElias :)