Welcome to Componly! Follow these steps to quickly get up to speed and make the most out of our platform:
Gain a comprehensive understanding of Componly by watching our product tour and demo video. This will give you an overview of our features and how to use them effectively. 2. Check Our Step-by-Step Documentation
Our detailed documentation will guide you through every step of using Componly.co. It covers all functionalities and provides solutions to common issues. Access the documentation here.
4. Determine What to Scan
Decide which design systems and components you want to scan. Prioritize based on your roadmap to ensure you're focusing on the most critical elements first.
5. Create Processes
Implement the following processes to maintain and improve your workflow:
Health Check for Development Before Every New PR: Ensure your code is always in top shape by performing a health check before submitting any new pull requests. Give a seat to all your frontend developers to do so.
Weekly Codebase Adoption Checks:
Regularly review your codebase to ensure all new standards and practices are being adopted correctly. Give a seat to all your frontend developers to do so.
Include Reports in Miro / Figjam Monthly Meetings:
Share time-based reports with stakeholders during your monthly meetings. These reports can demonstrate your progress and showcase the effectiveness of your team. Use Miro or Figjam for presenting these reports in a clear and engaging format.
6. Add Componly to your CI/CD pipeline
Go on the doc, then click on the tab 'CI/CD'. This guide will walk you through setting up the Componly CLI to run within a CI/CD pipeline. The tool calculates the coverage of design system usage in components and ensures that your codebase adheres to your defined design systems:
https://www.componly.co/docsBy following these steps, you'll ensure a smooth integration of Componly into your workflow, helping you maintain high standards and stay on track with your roadmap.
