devActivity Embeddable Widgets: Dynamic Insights for Your Documentation
The 'Embeddables' section within devActivity Settings empowers you to transform static documentation into dynamic, insightful resources. This feature allows you to generate markdown code for various widgets that display real-time development activity, bringing your team's progress and achievements to life directly within your most used collaboration tools.
What Are devActivity Embeddable Widgets?
devActivity Embeddable Widgets are dynamic snippets of markdown code that, when pasted into external documentation, render as live, interactive displays of your team's developer analytics. These widgets pull data directly from devActivity, ensuring that metrics like achievements, cycle time, and repository statistics are always current and accurate.
Value to Your Team and Documentation
By integrating devActivity widgets, you can significantly enhance your external project documentation, such as GitHub READMEs and Confluence pages. This eliminates the need for manual updates, ensuring that stakeholders, team members, and even new hires always have access to the latest metrics and achievements. It fosters transparency, celebrates team accomplishments, and provides continuous insight into development workflows, ultimately improving information accessibility and engagement across your organization.
Available Widget Types
devActivity offers a range of powerful widgets designed to showcase different aspects of your development activity:
- ACHIEVEMENTS WIDGET: Displays a vibrant grid of hexagonal badges, celebrating individual and team accomplishments like 'CAREER ADVISOR', 'PULL REQUEST PRODIGY', and 'CAPTAIN CODE'. This is perfect for showcasing recognition and fostering a positive team culture.
- CYCLE TIME (LAST 30 DAYS) WIDGET: Provides a detailed breakdown of your development cycle, including overall cycle time, coding time, pickup time, and review time. This widget is invaluable for identifying bottlenecks and optimizing workflow efficiency.
- REPO STATS (LAST 45 DAYS) WIDGET: Presents key statistics related to repository activity, such as the number of contributors, views, forks, and pull requests. It offers a quick overview of project engagement and health.
- Other Widgets: While not shown in the screenshot, devActivity also supports widgets for 'Top Contributors' and 'Active Challenges', further enriching your dynamic documentation capabilities.
How Embeddable Widgets Work
The process is straightforward: navigate to 'Settings' > 'Embeddables', select your desired widget, and click 'Preview / Copy Code'. This generates a unique markdown snippet that you can paste into any compatible external document. The widget then automatically renders and updates with the latest data from devActivity.
Who Benefits from Embeddable Widgets?
This feature is designed for a wide range of roles:
- Developers: To showcase personal achievements and team progress in project READMEs.
- Team Leads & Project Managers: To provide live performance metrics and insights to their teams and stakeholders.
- Technical Writers: To integrate dynamic data into user guides and internal documentation.
- Community Managers: To highlight active challenges and top contributors in public-facing documents.
