How to Embed devActivity Widgets into Your External Documentation
Introduction to Embeddable Widgets
devActivity's Embeddable Widgets feature allows you to bring live developer analytics and team insights directly into your external documentation. Whether you're updating a GitHub README, an internal Confluence page, or any other markdown-supported platform, these dynamic widgets ensure your data is always current without manual updates. This guide will walk you through the simple steps to generate and embed these powerful insights.
Steps to Embed devActivity Widgets
Follow these instructions to integrate devActivity widgets into your external documentation:
- Navigate to Embeddables: From your devActivity dashboard, click on 'Settings' in the navigation menu, then select the 'Embeddables' sub-section.
- Choose Your Widget: Browse the available widgets, such as 'ACHIEVEMENTS WIDGET', 'CYCLE TIME (LAST 30 DAYS) WIDGET', or 'REPO STATS (LAST 45 DAYS) WIDGET'. Each widget provides unique insights into your team's activity.
- Preview and Copy Code: For the desired widget, click the 'Preview / Copy Code' button. This action will generate and copy the necessary markdown code to your clipboard.
- Paste into Documentation: Open your external documentation platform (e.g., GitHub README, Confluence page, internal wiki). Paste the copied markdown code directly into the content area where you want the widget to appear.
- Dynamic Display: Once pasted and saved, the embedded widget will dynamically display up-to-date information, reflecting the latest data from devActivity. Your documentation will now feature live, engaging metrics.
Available Widget Types
The Embeddables section offers several dynamic widgets:
- ACHIEVEMENTS WIDGET: Showcases a grid of hexagonal badges representing developer achievements like 'PULL REQUEST PRODIGY' or 'CAPTAIN CODE'.
- CYCLE TIME (LAST 30 DAYS) WIDGET: Provides a breakdown of development cycle metrics, including total cycle time, coding time, pickup time, and review time.
- REPO STATS (LAST 45 DAYS) WIDGET: Displays key statistics related to repository activity over a specified period, such as contributors, views, and pull requests.
Why Embed devActivity Widgets?
Embedding devActivity widgets enhances your external project documentation with live, up-to-date metrics and achievements. This fosters transparency, celebrates team accomplishments, and provides continuous insight into development workflows directly within familiar collaboration tools, improving information accessibility and engagement.
