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 DocsExample #873

Merged
merged 10 commits into from
Jan 31, 2025
Merged

Conversation

chetan21122004
Copy link

@chetan21122004 chetan21122004 commented Dec 13, 2024

Description:
I’ve added the DocsExample component that allows toggling between an example and its code.

Issue Addressed:
Fixes #826. Also references #836 for additional context on previous discussions related to the component.

Guidance:
The new component enhances the documentation UI by toggling code visibility.

Steps to Test:

  1. Navigate to the KCardGrid documentation page.
  2. Verify that the example and code toggle correctly with a slide-up/slide-down animation.

Implementation Notes:

  • The DocsExample component uses a #code slot to accept code snippets in multiple languages.
  • Slide toggle animation is applied when showing/hiding the code.

Changelog

@chetan21122004 chetan21122004 mentioned this pull request Dec 15, 2024
@MisRob MisRob changed the title revert unwanted changes Add DocsExample Dec 16, 2024
@MisRob MisRob requested a review from ozer550 December 16, 2024 06:21
MisRob
MisRob previously requested changes Dec 16, 2024
Copy link
Member

@MisRob MisRob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @chetan21122004 and @ozer550, wonderful work so far. Posting few in-code comments, mostly last touches. Then I think we could be ready for merge.

@chetan21122004
Copy link
Author

chetan21122004 commented Dec 16, 2024

Hi @MisRob, Thank you for your detailed feedback. As a beginner, I found this task challenging and apologize for any inconvenience caused, including the unwanted changes I made as I didn’t use a formatter. I truly appreciate your patience and guidance. I will review your commits and make sure my setup avoids unrelated updates. I’m working on improving my coding practices and will run yarn lint-fix to ensure clean contributions. Your support means a lot, and I look forward to learning more from you. Thank you again!

@MisRob
Copy link
Member

MisRob commented Dec 16, 2024

No problem @chetan21122004, I think lots of it was actually caused by the Node version transition. Let's see how it goes, now we have a clean state. Let us know if something unexpected would happen with linting.

@ozer550
Copy link
Member

ozer550 commented Dec 17, 2024

Hi @chetan21122004! Regarding the change log, yes it should not be present in the PR. Rather we need to fill in the changelog in the pull request template. For example here.

@MisRob
Copy link
Member

MisRob commented Jan 14, 2025

Hi @chetan21122004, just checking in - would you need anything from us here?

@chetan21122004
Copy link
Author

chetan21122004 commented Jan 15, 2025

Hi @MisRob , Thanks for asking but now I didn't need anything , I will let you know if I have any issues, Thanks for your support, And few days I can't able to be active because my mid term examination is going on sorry for this..!

@MisRob
Copy link
Member

MisRob commented Jan 15, 2025

Great @chetan21122004, no pressure, I'm just checking in on PRs occasionally. This task has no deadline, please take all the time you need. Good luck with exams :)!

@MisRob
Copy link
Member

MisRob commented Jan 31, 2025

Hi @chetan21122004, we have some new dependencies on this pull request in #905 so I will go ahead and push the remaining cleanup here so we can merge. Also in #905, we discussed some changes to the DocsExample interface proposed in #845 that will be done in the course of #905, so I will have to unassign you from #845.

You're very welcome to keep an eye on 'help wanted' issues - over time there will be new ones regarding this component. I'm sorry for not waiting longer, this was the best solution I could think of to make work in those other areas manageable. Thanks a lot for this work, it has laid down very nice foundation!

Copy link
Member

@MisRob MisRob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @chetan21122004 and @ozer550! I will merge now so we can proceed with work that depends on this component mentioned earlier.

@MisRob MisRob merged commit 2303fac into learningequality:develop Jan 31, 2025
9 of 11 checks passed
learning-equality-bot bot pushed a commit that referenced this pull request Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a new documentation component DocsExample that allows to toggle between an example and its code
3 participants