kolibri-design-system Add documentation to the KTooltip page

🌱 Are you new to the codebase? Welcome! Please see the contributing guidelines.

Summary

The KTooltip documentation page lacks an overview and examples of usage. The goal of this issue is to:

[ ] Add the “Overview” section with a brief introduction on what the component is for.
[ ] Add the “Usage” section with sub-sections documenting:
- [ ] The basic usage with an example code snippet and the visualization of its output. The example should include reference and refs explanation and show how KTooltip is used together with another component, such as KIcon (Kolibri codebase examples).
- [ ] A visualization of the disabled state
- [ ] A visualization of all supported placements
- [ ] A visualization of maxWidth

Guidance

For consistency in documentation, first see the “Writing” guidelines and use existing pages for reference, such as the KTextbox documentation and KImg documentation pages.
Generally we try to strike a balance between documenting all important modes of a component, while not overwhelming readers with unnecessary details or exhaustive lists of all possible states.
Use simple, clear, and concise language. Think about whether what you are explaining can be easily understood by newcomers.
To understand the technical aspects of writing documentation, refer to:
- “How to update the documentation website”
- Documentation pages code, such as KTextbox docs source code or KImg's docs source code

Jul 26 '24 19:07 MisRob

I want to work on this Issue Please Assign This to me

Sep 12 '24 11:09 sruthin21

Thanks for your interest in picking this up @sruthin21!! I just assigned this issue to you :hugs:. Please let us know if there is anything we can help with :open_hands:.

Sep 12 '24 14:09 AlexVelezLl

sure @AlexVelezLl Thanks for assigning

Sep 12 '24 14:09 sruthin21

Work and review in https://github.com/learningequality/kolibri-design-system/pull/789 can serve as a good guidance since that PR nearly finished the issue.

Dec 02 '24 03:12 MisRob

I want to work on this issue .Can you please assign this to me.

Dec 05 '24 14:12 shruti862

Hi @shruti862, sure, thanks! Please read carefully the guidance, comments, and the referenced pull request - you can find all you need there to finish this successfully.

Dec 06 '24 05:12 MisRob

@MisRob Thank you for assigning the issue ; I have gone through the referenced PR soon I will raise PR.

Dec 06 '24 07:12 shruti862

@MisRob Can you please also review this PR ( whenever you get time ) to see if there any more changes needed.

Dec 09 '24 09:12 shruti862

Yes, @shruti862, I've just posted a comment there. Thank you.

Dec 09 '24 09:12 MisRob

@MisRob I did yarn lint-fix for linting issue in the new PR which only contains ktooltip file changes as you suggested ; please review it whenever you get time.

Dec 09 '24 12:12 shruti862

Thanks @shruti862

Dec 09 '24 15:12 MisRob

Closed by https://github.com/learningequality/kolibri-design-system/pull/859

Dec 16 '24 12:12 MisRob