Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
238 changes: 238 additions & 0 deletions DA Milestones/DevEx-WG-Overview/Q1-2026.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,238 @@
# Shared DevEx Report to the Open Source Committee (OSC)

---

**Reporting Period:** Q1-2026

**Prepared by:** Developer Experience Working Group

**Contributors:** Developer Advocates C2

**Submitted to:** Open Source Committee (OSC)

**by:** @danbaruka @hisisobate @Emmanuel-Tyty @HarunJr

---

## 1. Acceptance Criteria (OSC Reporting)

- **Progress reporting:** Developer Experience Working Group progress is provided to the Open Source Committee every four weeks, alternating developer advocate monthly.
- **Pain points & strategy:** A record of Developer Experience pain points is maintained for inclusion in the OSC’s Open Source Strategy, including a plan for improvement.
- **Common document:** Developer Advocates produce one common document (this report) to be shared with the OSC.

---

## 2. DevEx Working Group Overview

### Mission

Improve the accessibility, usability, and overall effectiveness of Cardano's developer tooling, documentation, and onboarding experience, ensuring developers worldwide can build efficiently and confidently within the Cardano ecosystem.

---

### Meeting Cadence

**Frequency:**

- Weekly sessions, organized in alternating time slots to accommodate global participation
- Sessions are organized in pairs, alternating between:
- One morning session
- One evening session the following week

This structure ensures inclusivity across time zones and regions.

**Format:**

- Online meetings
- Sessions are recorded when possible and shared with the community

**Planning Horizon:**

- Current planning covers Q1 2026 and early Q2 2026, with schedules published in advance to support predictable participation.

---

### Session Schedule (UTC)

**Example – Select a Meetup**


| Session Type | Day | Date | Time (UTC) |
| --------------- | --------- | ------------- | ---------- |
| Morning Session | Wednesday | 19 March 2026 | 07:00 UTC |
| Evening Session | Thursday | 27 March 2026 | 17:00 UTC |


This alternating schedule ensures that developers from different regions can consistently attend at least one session.

---

### Coordination & Resources


| Resource | Description | Link |
| ------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| DevEx Website | Main documentation and resource hub | [devex.intersectmbo.org](https://devex.intersectmbo.org/) |
| Session Plan | Developer Experience WG – Global Impact (Developer Advocate) Session Plan | [View Spreadsheet](https://docs.google.com/spreadsheets/d/1zJqCgjwqDzZ_4pPb9pODPuFDGt1HujOeQEpmy-OIWEw/edit?gid=0#gid=0) |


These resources are actively maintained and used to coordinate sessions, track participation, and align efforts across Developer Advocates.

---

### Participants


| Participant Type | Role |
| --------------------------------------- | ------------------------------------------------ |
| Developer Advocates | Lead sessions and community engagement |
| Core Cardano Contributors | Provide technical expertise and guidance |
| Technical Working Group Representatives | Contribute domain-specific knowledge (as needed) |


---

## 3. Current DevEx Status (High-Level Assessment)

### Status Summary


| Area | Status | Priority |
| ------------------------------------- | -------------------- | -------- |
| Developer Onboarding | ⚠️ Needs Improvement | High |
| Documentation Quality | ✅ Good | Medium |
| Session Participation & Accessibility | ✅ Good | Medium |
| Website & Infrastructure | ✅ Actively Improving | Low |


---

### Developer Onboarding

**Status:** ⚠️ **Needs Improvement**

**Assessment:**

Developer documentation remains fragmented and scattered across multiple repositories and platforms. New developers often lack a clear, structured roadmap indicating where to start and how to progress.

**Key Need:**

- A unified onboarding roadmap for new developers
- Clear entry points based on developer profiles and use cases

---

### Documentation Quality

**Status:** ✅ **Good**

**Assessment:**

- Core repositories and the DevEx docs site are well-documented and actively maintained
- New integration guides (e.g. Blaze SDK + Yaci Store) and structured session content are improving practical, step-by-step guidance
- Ongoing work on structure and cross-linking continues to improve discoverability

---

### DevEx Session Participation & Accessibility

**Status:** ✅ **Good**

**Assessment:**

Session access and discoverability have improved. The following actions are in place and working well:


| Action | Description | Impact |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
| Floating Action Button | Added to DevEx documentation website to direct developers to live sessions, provide quick access to meeting links, and enable easy calendar integration | High |
| Calendar Integration | Embedded session links directly into developer calendars to reduce friction | High |
| Label clarity | Renamed floating button label from "Meetup" to "DevEx Sessions" for clarity (#171) | Medium |


---

### DevEx Website & Infrastructure

**Status:** ✅ **Actively Improving**

**Progress Made (Q1 2026):**

- Documentation search functionality with dark mode support added
- Docusaurus configuration and dependencies updated; sitemap and metadata enhanced
- Session documentation expanded (e.g. Wallet Integration, Smart Contracts & Languages, Session 1 & 2 structure)
- Maintainer Retainer Program (MRP) section added and expanded
- FAQs and contribution guide updates

**Current State:**


| Aspect | Status |
| ----------- | -------------------------------------- |
| Maintenance | Actively maintained |
| Updates | Regularly updated |
| Purpose | Central reference point for developers |


---

## 4. DevEx Pain Points & Plan for Improvement (for OSC Open Source Strategy)

### Resolved in Q1 2026

The following items were previously recorded as pain points and have been addressed:

| Item | Resolution |
|------|------------|
| **Session discoverability** | DevEx sessions are now documented in the docs site with full calendar information, so developers have clear, timely access to meeting links and schedules. |
| **Changelog discoverability** | Changelog is now discoverable (e.g. dedicated exposure in docs / process in place). |
| **Release cadence** | A documented release cadence (quarterly tag/release process) is now in place. |

---

### Pain Points to Address


| Pain Point | Description | Priority |
| -------------------------- | ---------------------------------------------------------------------- | -------- |
| Fragmented onboarding | No single, clear roadmap for new developers; entry points vary by repo | High |
| Inconsistent doc structure | Different repos use different layouts and conventions | Medium |
| Limited cross-linking | Related resources (e.g. Blaze, Yaci, wallets) not consistently linked | Medium |


### Plan for Improvement

- **Short term:** Continue weekly DevEx sessions; complete and merge integration guides (e.g. Blaze + Yaci Store).
- **Medium term:** Propose a unified onboarding roadmap and standardise documentation structure for key Core Cardano repositories; improve cross-linking.
- **Long term:** Align DevEx deliverables with OSC Open Source Strategy; consider RSS/Atom feed for changelog and machine-readable doc index for discoverability where useful.

---

## 5. Draft Documentation for Core Cardano Repositories

Developer Advocates create draft documentation for various Core Cardano repositories. These documents can be reviewed by OSC, TSC, and relevant Technical Working Group members for inclusion.

### Open for Review


| Document / PR | Description | Link | Status |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------- |
| **Blaze SDK + Yaci Store integration** | Technical integration guide for using **Yaci Store** as a local Blockfrost-compatible indexer with **Blaze SDK** on Cardano. Collaborative documentation between the Developer Advocate team, the Yaci team, and the Blaze SDK team. Covers architecture, configuration, trade-offs, and references to official Blaze and Yaci DevKit resources. | [PR #186](https://github.com/IntersectMBO/developer-experience/pull/186) | Open – review appreciated by OSC, TSC, and relevant TWG members when time permits |


---

## 6. Ongoing Improvements


| Improvement Area | Description | Status |
| --------------------- | ---------------------------------------------------------------- | --------------------- |
| Documentation Content | Continuous updates to documentation content | In Progress |
| Feedback Integration | Regular feedback loops from DevEx sessions | Active |
| Content Structuring | Progressive structuring of content based on real developer needs | Ongoing |
| Strategic Alignment | Alignment with OSC priorities and Open Source Strategy goals | Active |
| Integration Guides | New "Integration Guides" section and Blaze + Yaci Store guide | In Progress (PR #186) |


---