Skip to content

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

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

Open
4 tasks
Tracked by #1654
idanidan29 opened this issue May 16, 2025 · 0 comments
Open
4 tasks
Tracked by #1654
Labels
📝 Documentation Indicates improvements or additions to documentation. Status: Triage This is the initial status for an issue that requires triage.

Comments

@idanidan29
Copy link
Contributor

idanidan29 commented May 16, 2025

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
@idanidan29 idanidan29 added 📝 Documentation Indicates improvements or additions to documentation. Status: Triage This is the initial status for an issue that requires triage. labels May 16, 2025
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

1 participant