Skip to content

Commit 4fb4be2

Browse files
authored
Merge pull request #187 from danbaruka/DA-milestones
adding/updating the Q1-2026 report
2 parents 47757c5 + 6c62bd8 commit 4fb4be2

2 files changed

Lines changed: 238 additions & 0 deletions

File tree

Lines changed: 238 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,238 @@
1+
# Shared DevEx Report to the Open Source Committee (OSC)
2+
3+
---
4+
5+
**Reporting Period:** Q1-2026
6+
7+
**Prepared by:** Developer Experience Working Group
8+
9+
**Contributors:** Developer Advocates C2
10+
11+
**Submitted to:** Open Source Committee (OSC)
12+
13+
**by:** @danbaruka @hisisobate @Emmanuel-Tyty @HarunJr
14+
15+
---
16+
17+
## 1. Acceptance Criteria (OSC Reporting)
18+
19+
- **Progress reporting:** Developer Experience Working Group progress is provided to the Open Source Committee every four weeks, alternating developer advocate monthly.
20+
- **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.
21+
- **Common document:** Developer Advocates produce one common document (this report) to be shared with the OSC.
22+
23+
---
24+
25+
## 2. DevEx Working Group Overview
26+
27+
### Mission
28+
29+
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.
30+
31+
---
32+
33+
### Meeting Cadence
34+
35+
**Frequency:**
36+
37+
- Weekly sessions, organized in alternating time slots to accommodate global participation
38+
- Sessions are organized in pairs, alternating between:
39+
- One morning session
40+
- One evening session the following week
41+
42+
This structure ensures inclusivity across time zones and regions.
43+
44+
**Format:**
45+
46+
- Online meetings
47+
- Sessions are recorded when possible and shared with the community
48+
49+
**Planning Horizon:**
50+
51+
- Current planning covers Q1 2026 and early Q2 2026, with schedules published in advance to support predictable participation.
52+
53+
---
54+
55+
### Session Schedule (UTC)
56+
57+
**Example – Select a Meetup**
58+
59+
60+
| Session Type | Day | Date | Time (UTC) |
61+
| --------------- | --------- | ------------- | ---------- |
62+
| Morning Session | Wednesday | 19 March 2026 | 07:00 UTC |
63+
| Evening Session | Thursday | 27 March 2026 | 17:00 UTC |
64+
65+
66+
This alternating schedule ensures that developers from different regions can consistently attend at least one session.
67+
68+
---
69+
70+
### Coordination & Resources
71+
72+
73+
| Resource | Description | Link |
74+
| ------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
75+
| DevEx Website | Main documentation and resource hub | [devex.intersectmbo.org](https://devex.intersectmbo.org/) |
76+
| 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) |
77+
78+
79+
These resources are actively maintained and used to coordinate sessions, track participation, and align efforts across Developer Advocates.
80+
81+
---
82+
83+
### Participants
84+
85+
86+
| Participant Type | Role |
87+
| --------------------------------------- | ------------------------------------------------ |
88+
| Developer Advocates | Lead sessions and community engagement |
89+
| Core Cardano Contributors | Provide technical expertise and guidance |
90+
| Technical Working Group Representatives | Contribute domain-specific knowledge (as needed) |
91+
92+
93+
---
94+
95+
## 3. Current DevEx Status (High-Level Assessment)
96+
97+
### Status Summary
98+
99+
100+
| Area | Status | Priority |
101+
| ------------------------------------- | -------------------- | -------- |
102+
| Developer Onboarding | ⚠️ Needs Improvement | High |
103+
| Documentation Quality | ✅ Good | Medium |
104+
| Session Participation & Accessibility | ✅ Good | Medium |
105+
| Website & Infrastructure | ✅ Actively Improving | Low |
106+
107+
108+
---
109+
110+
### Developer Onboarding
111+
112+
**Status:** ⚠️ **Needs Improvement**
113+
114+
**Assessment:**
115+
116+
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.
117+
118+
**Key Need:**
119+
120+
- A unified onboarding roadmap for new developers
121+
- Clear entry points based on developer profiles and use cases
122+
123+
---
124+
125+
### Documentation Quality
126+
127+
**Status:****Good**
128+
129+
**Assessment:**
130+
131+
- Core repositories and the DevEx docs site are well-documented and actively maintained
132+
- New integration guides (e.g. Blaze SDK + Yaci Store) and structured session content are improving practical, step-by-step guidance
133+
- Ongoing work on structure and cross-linking continues to improve discoverability
134+
135+
---
136+
137+
### DevEx Session Participation & Accessibility
138+
139+
**Status:****Good**
140+
141+
**Assessment:**
142+
143+
Session access and discoverability have improved. The following actions are in place and working well:
144+
145+
146+
| Action | Description | Impact |
147+
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
148+
| 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 |
149+
| Calendar Integration | Embedded session links directly into developer calendars to reduce friction | High |
150+
| Label clarity | Renamed floating button label from "Meetup" to "DevEx Sessions" for clarity (#171) | Medium |
151+
152+
153+
---
154+
155+
### DevEx Website & Infrastructure
156+
157+
**Status:****Actively Improving**
158+
159+
**Progress Made (Q1 2026):**
160+
161+
- Documentation search functionality with dark mode support added
162+
- Docusaurus configuration and dependencies updated; sitemap and metadata enhanced
163+
- Session documentation expanded (e.g. Wallet Integration, Smart Contracts & Languages, Session 1 & 2 structure)
164+
- Maintainer Retainer Program (MRP) section added and expanded
165+
- FAQs and contribution guide updates
166+
167+
**Current State:**
168+
169+
170+
| Aspect | Status |
171+
| ----------- | -------------------------------------- |
172+
| Maintenance | Actively maintained |
173+
| Updates | Regularly updated |
174+
| Purpose | Central reference point for developers |
175+
176+
177+
---
178+
179+
## 4. DevEx Pain Points & Plan for Improvement (for OSC Open Source Strategy)
180+
181+
### Resolved in Q1 2026
182+
183+
The following items were previously recorded as pain points and have been addressed:
184+
185+
| Item | Resolution |
186+
|------|------------|
187+
| **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. |
188+
| **Changelog discoverability** | Changelog is now discoverable (e.g. dedicated exposure in docs / process in place). |
189+
| **Release cadence** | A documented release cadence (quarterly tag/release process) is now in place. |
190+
191+
---
192+
193+
### Pain Points to Address
194+
195+
196+
| Pain Point | Description | Priority |
197+
| -------------------------- | ---------------------------------------------------------------------- | -------- |
198+
| Fragmented onboarding | No single, clear roadmap for new developers; entry points vary by repo | High |
199+
| Inconsistent doc structure | Different repos use different layouts and conventions | Medium |
200+
| Limited cross-linking | Related resources (e.g. Blaze, Yaci, wallets) not consistently linked | Medium |
201+
202+
203+
### Plan for Improvement
204+
205+
- **Short term:** Continue weekly DevEx sessions; complete and merge integration guides (e.g. Blaze + Yaci Store).
206+
- **Medium term:** Propose a unified onboarding roadmap and standardise documentation structure for key Core Cardano repositories; improve cross-linking.
207+
- **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.
208+
209+
---
210+
211+
## 5. Draft Documentation for Core Cardano Repositories
212+
213+
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.
214+
215+
### Open for Review
216+
217+
218+
| Document / PR | Description | Link | Status |
219+
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------- |
220+
| **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 |
221+
222+
223+
---
224+
225+
## 6. Ongoing Improvements
226+
227+
228+
| Improvement Area | Description | Status |
229+
| --------------------- | ---------------------------------------------------------------- | --------------------- |
230+
| Documentation Content | Continuous updates to documentation content | In Progress |
231+
| Feedback Integration | Regular feedback loops from DevEx sessions | Active |
232+
| Content Structuring | Progressive structuring of content based on real developer needs | Ongoing |
233+
| Strategic Alignment | Alignment with OSC priorities and Open Source Strategy goals | Active |
234+
| Integration Guides | New "Integration Guides" section and Blaze + Yaci Store guide | In Progress (PR #186) |
235+
236+
237+
---
238+
File renamed without changes.

0 commit comments

Comments
 (0)