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

Enhancement: Add tour of JSON Schema section on homepage (#1502) #1532

Conversation

KajalMishra-29
Copy link

@KajalMishra-29 KajalMishra-29 commented Mar 16, 2025

This PR adds a guided tour to the homepage using react-joyride, helping new users explore key components of the homepage. The tour highlights important elements in the navbar and main sections, providing descriptions for each.

Kind of Change: Feature enhancement

issue number
closes : #1502

Changes Made

  • Created a new component TourGuide.tsx that:

    • Defines tour steps with explanations for home, docs, specification, tools, blog, community, GitHub, and more
    • Uses useState and useEffect to manage the tour lifecycle
    • Includes a Start Tour button (bottom-right) to trigger the tour
    • Ensures proper styling and usability with continuous mode, and showSkipButton
  • Integrated TourGuide.tsx in index.page.tsx so the tour is available on the homepage.

How to Test

  • Navigate to the homepage (/).
  • Click the "Start Tour" button (bottom-right corner).
  • The tour should highlight and describe key components smoothly.

image
description for element's can be changed as required.

Let me know if any refinements are needed! 🚀

@KajalMishra-29 KajalMishra-29 requested a review from a team as a code owner March 16, 2025 17:34
Copy link

Hi @KajalMishra-29! Thanks a lot for your contribution!

I noticed that the following required information is missing or incomplete: issue reference, kind of change description

Please update the PR description to include this information. You can find placeholders in the PR template for these items.

Thanks a lot!

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to the JSON Schema Community. Thanks a lot for creating your first pull request!! 🎉🎉 We are so excited you are here! We hope this is only the first of many! For more details check out README.md file.

@benjagm
Copy link
Collaborator

benjagm commented Mar 16, 2025

Thanks a lot @KajalMishra-29, this is a great idea, but as of now we prefer to keep the onboarding experience and the codebase as simple as possible.

@benjagm
Copy link
Collaborator

benjagm commented Mar 16, 2025

Is there a PR where we discussed this?

Copy link

Hi @KajalMishra-29! Thanks a lot for your contribution!

I noticed that the following required information is missing or incomplete: kind of change description

Please update the PR description to include this information. You can find placeholders in the PR template for these items.

Thanks a lot!

@KajalMishra-29
Copy link
Author

Is there a PR where we discussed this?

This enhancement was based on issue #1502, which suggests adding a guided tour to the homepage.

@KajalMishra-29
Copy link
Author

Thanks a lot @KajalMishra-29, this is a great idea, but as of now we prefer to keep the onboarding experience and the codebase as simple as possible.

Thank you for the feedback! I understand the concern about keeping the onboarding experience simple. Would you be open to a more minimal version of the tour, focusing only on the most essential elements (e.g., Docs, Specification, and Community)? I can modify the implementation accordingly.

Copy link

Hi @KajalMishra-29! Thanks a lot for your contribution!

I noticed that the following required information is missing or incomplete: issue reference, kind of change description

Please update the PR description to include this information. You can find placeholders in the PR template for these items.

Thanks a lot!

@KajalMishra-29 KajalMishra-29 deleted the enhancement-homepage-tourguide branch March 16, 2025 18:33
@benjagm
Copy link
Collaborator

benjagm commented Mar 16, 2025

Let's continue the discussion on the issue first.

@KajalMishra-29 KajalMishra-29 restored the enhancement-homepage-tourguide branch March 16, 2025 18:34
Copy link

Hi @KajalMishra-29! Thanks a lot for your contribution!

I noticed that the following required information is missing or incomplete: issue reference, kind of change description

Please update the PR description to include this information. You can find placeholders in the PR template for these items.

Thanks a lot!

@benjagm
Copy link
Collaborator

benjagm commented Mar 16, 2025

Closing this PR as the issue is still on triage.

@benjagm benjagm closed this Mar 16, 2025
@KajalMishra-29 KajalMishra-29 deleted the enhancement-homepage-tourguide branch March 16, 2025 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨ Enhancement: Add tour of json schema section on homepage.
2 participants