[DOCS] Seeking Contributions to Improve & Migrate Documentation

[JairajJangle]

Is your feature request related to a problem? Please describe.

As the library continues to grow with new features, maintaining documentation within a single README.md file is becoming increasingly difficult. The current format makes it harder to manage, update, and navigate, especially for new users who are trying to understand the library's capabilities.

Describe the solution you'd like

A dedicated documentation site built using VitePress to provide:

• Structured & Organized Docs – Break down documentation into sections (e.g., Getting Started, API Reference, Examples, FAQs, etc.)
• Easier Navigation – Allow users to quickly find relevant information without scrolling through a long README.
• Better Scalability – As more features are added, a documentation site will be easier to maintain compared to a growing markdown file.
• Live Code Examples – Potentially integrate interactive code snippets to showcase how different features work.

Describe alternatives you've considered

• Keeping the documentation within README.md but splitting it into multiple files within a /docs folder.
• Using Docusaurus, though VitePress seems lighter and better suited for this project.

Screenshots or screen records

N/A

Additional context

This would greatly improve the developer experience by making it easier to onboard new users, find information, and keep documentation up to date as the library evolves.

Would you like to work on this feature?

I’d be happy to set up the initial structure, but contributions from the community would be welcome to improve and expand the docs over time.

[Imaginativeone]

I would LOVE to work on this feature! Would you onboard me for this?

[JairajJangle]

Hey @Imaginativeone! 👋

That’s awesome to hear! I’d love to have you onboard for this. 🚀

To give you a better idea of what I have in mind, here are some examples of documentation sites that follow a clean and structured approach:

• WebView Bridge Docs
• Shopify FlashList Docs
• Hot Updater Docs

The goal is to have something similar—well-structured, easy to navigate, and scalable. Feel free to take inspiration from these sites in terms of layout, navigation, and organization.

Let me know if you have any questions or need any help getting started. Looking forward to your contributions! 😊

[Imaginativeone]

@JairajJangle I took a look at the sites you recommended as well as the VitePress Documentation. I'm still working on it. Question: Will this be a separate site altogether?

[JairajJangle]

@Imaginativeone

Thanks for checking out the examples and VitePress documentation! Glad to hear you’re working on it. 😊

To answer your question:

• The docs site will be deployed to github.io, ideally using GitHub Pages for easy hosting.
• The documentation source will be maintained within the same repository and inside a /docs folder. This keeps everything in one place and allows for easier maintenance alongside the library itself.
• We’ll set up a simple build process to generate and deploy the docs when changes are made.
• The goal is to structure it cleanly with sections like Getting Started, API Reference, Examples, FAQs, etc., similar to the examples I shared.

Let me know if you have any other questions! Looking forward to seeing what you come up with. 🚀😊