Skip to content
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

Add documentation to the KTooltip page #694

Closed
6 tasks
MisRob opened this issue Jul 26, 2024 · 12 comments
Closed
6 tasks

Add documentation to the KTooltip page #694

MisRob opened this issue Jul 26, 2024 · 12 comments
Assignees
Labels
category: docs content Design patterns and component usage Component: KTooltip good first issue Self-contained, straightforward, low-complexity help wanted Open source contributors welcome P2 - normal Priority: Nice to have

Comments

@MisRob
Copy link
Member

MisRob commented Jul 26, 2024

🌱 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

@MisRob MisRob added category: docs content Design patterns and component usage P2 - normal Priority: Nice to have good first issue Self-contained, straightforward, low-complexity help wanted Open source contributors welcome Component: KTooltip labels Jul 26, 2024
@sruthin21
Copy link

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

@AlexVelezLl
Copy link
Member

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

@sruthin21
Copy link

sure @AlexVelezLl Thanks for assigning

@MisRob
Copy link
Member Author

MisRob commented Dec 2, 2024

Work and review in #789 can serve as a good guidance since that PR nearly finished the issue.

@shruti862
Copy link
Contributor

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

@MisRob
Copy link
Member Author

MisRob commented Dec 6, 2024

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.

@shruti862
Copy link
Contributor

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

@shruti862
Copy link
Contributor

shruti862 commented Dec 9, 2024

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

@MisRob
Copy link
Member Author

MisRob commented Dec 9, 2024

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

@shruti862 shruti862 mentioned this issue Dec 9, 2024
8 tasks
@shruti862
Copy link
Contributor

@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.

@MisRob
Copy link
Member Author

MisRob commented Dec 9, 2024

Thanks @shruti862

MisRob added a commit that referenced this issue Dec 16, 2024
@MisRob
Copy link
Member Author

MisRob commented Dec 16, 2024

Closed by #859

@MisRob MisRob closed this as completed Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: docs content Design patterns and component usage Component: KTooltip good first issue Self-contained, straightforward, low-complexity help wanted Open source contributors welcome P2 - normal Priority: Nice to have
Projects
None yet
Development

No branches or pull requests

4 participants