Improve Flexilla Documentation and Add Interactive Examples

[Johnkat-Mj]

Hello, Hacktoberfest participants!

We’re inviting talented developers to contribute to Flexilla, a CSS framework-agnostic library designed for interactive components like dropdowns, accordions, tabs and more.

What we need:

We’re looking for contributors to help enhance the Flexilla library in a few key areas:

1. Add Component Descriptions:

   • Expand on the existing component documentation to include detailed descriptions for each component (dropdown, accordion, tabs, etc.).
   • Explain the purpose of each component, how it works, and the benefits of using it in various projects.

2. Usage Examples:

   • Add code snippets to demonstrate how to use each component with different CSS frameworks (TailwindCSS, UnoCSS, or plain CSS).
   • Where applicable, include examples of custom configurations or additional options.

3. Interactive Demos:

   • If possible, create interactive examples using tools like CodeSandbox or CodePen that allow users to see the components in action and experiment with them directly.
   • Link these examples in the documentation to improve understanding and engagement.

4. Getting Started Guide:

   • Enhance the “Getting Started” section to guide users through the setup and installation process, including npm, CDN, and script-based installation methods.
   • Clarify the dependencies and any prerequisites needed for setting up Flexilla.

5. FAQ Section:

   • Add an FAQ section to address common questions and troubleshooting tips.
   • Include answers on compatibility, component usage, and configuration options.

Resources

To get you started, check out Flexilla's documentation and explore our existing codebase. These resources will provide you with a clear understanding of how Flexilla works and where you can contribute. Also you can read this blog post to understand the motivation behind the creation of this tool.

Recap Tasks

• [ ] faq section
• [ ] getting started guide
• [ ] interactive demos
• [ ] usage examples
• [ ] component descriptions

Additional Notes:

Feel free to contribute with your own ideas for improving the documentation. If you need any assistance or have questions, reach out, and we’ll be happy to help! Your work will greatly enhance Flexilla's usability and user experience for developers worldwide.

[hemangtk]

Hey @Johnkat-Mj does all the 5 changes come under 1 pr or 1 pr for each ie 5 pr in total?

[Johnkat-Mj]

Hey @hemangtk 1 change 1 PR Each PR must contain only 1 change

[hemangtk]

Thanks for your reply @Johnkat-Mj i would like to work on the faqs section could you please assign me the issue

[Johnkat-Mj]

@hemangtk done and let me know if you need some more details

[hemangtk]

hey @Johnkat-Mj just a quick question to know if i have understood the issue properly as i can see theres already faq section, do you want to me add relevent questions there?

[Johnkat-Mj]

Hey @hemangtk Although there's already an FAQ section, it doesn't cover everything at the moment. You can review it and make improvements, or add more questions and answers if possible... Just make it clear ... Also check https://flexilla-docs.vercel.app/docs/getting-started

[hemangtk]

got it! so you want me to make changes in the docs page or the home page really sorry for the questions but just making sure i do the right job

[Johnkat-Mj]

@hemangtk in both, if you can

[hemangtk]

Hey @Johnkat-Mj as I have other issues to work on as well I would like to update the faq section where it is prioritised

[Johnkat-Mj]

@hemangtk Okay, just do what's right. Also don't forget to mention this issue in the PR. A star ✨ on this repository can also help.

[gpatchikoru]

@Johnkat-Mj i would like to work on Getting Started Guide: could you please assign me.

[gpatchikoru]

this one also Interactive Demos: also first i will work on Getting Started Guide:

[Johnkat-Mj]

@gpatchikoru right, I'm gonna do this soon

[gpatchikoru]

yes, okay thank you.

[gpatchikoru]

updated branch for Getting Started Guide. please check pr request let me know any feedback pr:https://github.com/unify-ui-dev/flexilla/pull/93

[gpatchikoru]

please check PR let me know if you required any changes

[Johnkat-Mj]

@gpatchikoru I'm on it now