[📝 Docs]: Documentation & Guidelines for Future Component Development

[idanidan29]

What Docs changes are you proposing?

Description

Establish clear and accessible documentation to guide future component development using the updated ShadCN/UI-based design system. This will help maintain consistency, reduce onboarding time for new contributors, and streamline development workflows.

Tasks

• Write a step-by-step guide for creating new components within the current UI system
• Include examples of using common ShadCN/UI primitives (e.g., <Button>, <Dialog>, <Table>)
• Document best practices for:
  • Component structure and file naming
  • Accessibility considerations
  • Test coverage (unit and visual)
  • Code comments and documentation standards
• Add a section on how to contribute new components in the project README or CONTRIBUTING.md

[vtushar06]

Hi @idanidan29 👋

I’d like to help triage or contribute to this documentation enhancement. The proposed tasks around establishing a consistent guide for component development using ShadCN/UI sound valuable, especially for improving contributor onboarding and maintaining design consistency.

Before I begin, could you confirm:
• If there’s an existing style guide or draft I should refer to?
• Should this documentation be added under a specific docs/ directory or directly within the CONTRIBUTING.md?

Happy to assist wherever needed. Let me know how I can proceed!

Thanks!