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

[📝 Docs]: Enhanced SEO and Structure for /docs/index.page.tsx Documentation (#1242) #1238

Closed
wants to merge 3 commits into from

Conversation

adityajha2005
Copy link
Contributor

What kind of change does this PR introduce?

  • Documentation update / improvement

Screenshots/videos:

If relevant, did you update the documentation?

  • Yes, updated documentation for /docs/index.page.tsx as part of this PR.

Summary

  • This PR enhances the /docs/index.page.tsx page by improving the documentation structure, making the code more maintainable, and improving SEO with meta descriptions.
  • The update includes semantic HTML, better code organization, and a more responsive design using Tailwind classes. These changes ensure the documentation is easier to update and understand.
  • Moved cards data into a constant (CARDS_DATA) to make future updates easier and reduce code duplication.
  • Improved component structure with a renderCards method for better readability.

Does this PR introduce a breaking change?

  • No

@adityajha2005 adityajha2005 requested a review from a team as a code owner January 3, 2025 20:01
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.

Copy link

github-actions bot commented Jan 3, 2025

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
website ✅ Ready (View Log) Visit Preview 8901682

Copy link

codecov bot commented Jan 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5114356) to head (8901682).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1238   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          373       373           
  Branches        94        94           
=========================================
  Hits           373       373           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@DhairyaMajmudar
Copy link
Member

@adityajha2005 pls. mention the issue number you're trying to solve with this PR

@adityajha2005
Copy link
Contributor Author

@DhairyaMajmudar

[📝 Docs]: Improved /docs/index.page.tsx structure and SEO #1242

@adityajha2005 adityajha2005 changed the title Improved Documentation for /docs/index.page.tsx [📝 Docs]: Enhanced SEO and Structure for /docs/index.page.tsx Documentation (#1242) Jan 4, 2025
@benjagm
Copy link
Collaborator

benjagm commented Jan 7, 2025

Hi @adityajha2005 . Please follow the contributing guidelines before submitting a PR. Every PR needs an Issue and before submitting a PR you need to get assigned to that issue.

@benjagm benjagm closed this Jan 7, 2025
@adityajha2005
Copy link
Contributor Author

Hi @adityajha2005 . Please follow the contributing guidelines before submitting a PR. Every PR needs an Issue and before submitting a PR you need to get assigned to that issue.

Yes sir sorry , would consider it now onwards.

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.

3 participants