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]: Improved /docs/index.page.tsx structure and SEO #1242

Open
1 task done
adityajha2005 opened this issue Jan 4, 2025 · 2 comments
Open
1 task done

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

adityajha2005 opened this issue Jan 4, 2025 · 2 comments
Labels
📝 Documentation Indicates improvements or additions to documentation. Status: Triage This is the initial status for an issue that requires triage.

Comments

@adityajha2005
Copy link
Contributor

What Docs changes are you proposing?

I’m suggesting some improvements to the /docs/index.page.tsx page, including:

Cleaning up the code for better readability and maintainability.
Adding semantic HTML to improve accessibility and structure.
Enhancing SEO with meta descriptions to make the docs more discoverable.
Making the page more responsive by improving the use of Tailwind classes.
Organizing the card data into a constant (CARDS_DATA) to make future updates easier

Right now, the page could be more user-friendly and maintainable. The current structure makes it harder to update or extend. Also, accessibility and SEO improvements can help ensure the docs reach and serve a wider audience effectively.

It will benefit by providing a better user experience, easier navigation, and more maintainable docs for contributors.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@adityajha2005 adityajha2005 added Status: Triage This is the initial status for an issue that requires triage. 📝 Documentation Indicates improvements or additions to documentation. labels Jan 4, 2025
Copy link

github-actions bot commented Jan 4, 2025

Welcome to the JSON Schema Community. We are so excited you are here! Thanks a lot for reporting your first issue!! 🎉🎉 Please make sure to take a look at our contributors guide if you plan on opening a pull request.
For more details, check out the README.md file.

@DhairyaMajmudar
Copy link
Member

Hi @adityajha2005 can you pls. show some stats/data of improved SEO after performing these changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Documentation Indicates improvements or additions to documentation. Status: Triage This is the initial status for an issue that requires triage.
Projects
None yet
Development

No branches or pull requests

2 participants