From ea2335ddd8bb16f3573cc92e2197ccb9ce0ffeab Mon Sep 17 00:00:00 2001 From: danbaruka <46156791+danbaruka@users.noreply.github.com> Date: Thu, 19 Mar 2026 12:00:00 +0400 Subject: [PATCH] Revise README.md to enhance clarity and structure for the Developer Experience Working Group. Updated project overview, mission, focus areas, and added visual elements for better engagement. Improved accessibility of information for developers and stakeholders in the Cardano ecosystem. --- README.md | 290 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 205 insertions(+), 85 deletions(-) diff --git a/README.md b/README.md index a66c6ba1..e4e7e599 100644 --- a/README.md +++ b/README.md @@ -1,90 +1,210 @@ -# Welcome to the Intersect MBO Developer Experience Working Group - -## Our Mission -We are a community of `Developer Advocates` from `IntersectMBO` focused on enhancing the developer experience within the Cardano ecosystem. Our goal is to identify, address, and improve key aspects of the development process to make building on Cardano more accessible, efficient, and rewarding. - -Learn more about our initiatives and resources at our website: [Intersect MBO Developers Experience Website](devex.intersectmbo.org/) - - -## What We Do - -- Identify and prioritize developer experience issues in the Cardano ecosystem. -- Propose and implement solutions to improve tooling, documentation, and workflows. -- Foster collaboration between developers, projects, and stakeholders. -- Support multi-language integration. -- Develop and workshop a Developer Thriving Framework to address social barriers and improve community engagement. -- Focus on the human component of developer experience, beyond just documentation and technology. -- Organize collaborative workshops to gather diverse perspectives and create shared understanding. -- Address pain points and obstacles that hinder newcomer involvement and growth. -- Build trust and break down silos within the developer community. - -## Key Focus Areas -- **Onboarding and Documentation** -- **Tooling and Development Workflows** -- **Collaboration with other developers in the ecosystem** -- **Collecting feedback from developers** -- **Community Support and Knowledge Sharing** - -## How to Get Involved -- **Meetings**: Join our weekly Developer experience working group sessions by subscribing to the [Intersect Event calendar](https://calendar.google.com/calendar/u/1?cid=Y19iMGMyODE3NWE2NTBkOGUwNzIwNTM2ZGU4OWE0NDMxMjFiYTcxYTVkMDgxYmRiOWU1NGRiZTU2NjI1NGY5ZGUwQGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20). -- **GitHub**: Most discussions will happen in Github [issues](https://github.com/IntersectMBO/developer-experience/issues) and [pull requests](https://github.com/IntersectMBO/developer-experience/pulls). Issues are the problems faced by the Cardano Developer community and PR's propose solutions. Participate in [discussions](https://github.com/IntersectMBO/developer-experience/discussions/) and contribute to projects -- Join **Intersect**: [Become a Member](https://members.intersectmbo.org/registration) -- **Discord**: [Dev-Ex WG](https://discord.com/channels/1136727663583698984/1250047836339306526) -- **Share Feedback**: Share your feedback on our discord and help us improve the ecosystem. - -## Developer Advocates -Meet and connect with our past and present developer advocates: -- **Current Cohort**: - - [Uche](https://www.linkedin.com/in/thisisobate) - - Schedule a call with Uche [here](https://calendar.app.google/6HC9yHfTHrQ1dfcB9) - - Discord: @obate. - - [Emmanuel](https://www.linkedin.com/in/emmanuel-shikuku-devops/) - - X (Twitter): [@Emmanuel_tyty](https://x.com/Emmanuel_tyty) - - Discord: @emmanueltyty - - Schedule a call with Emmanuel [here](https://calendar.app.google/3LGaFshgi7q9fsQD8) - - [Dan](https://www.linkedin.com/in/danbaruka/) - - X (Twitter): [@danamphred](https://x.com/danamphred) - - Discord: @danamphred - - Schedule a call with Dan [here](https://calendar.app.google/T1BuH5EnRDyMTsyV8) - - [Harun](https://www.linkedin.com/in/harunslinked/) - - Discord: @wesh09 - - Schedule a call with Harun [here](https://calendly.com/harunm28/30min) -- **Past Cohort**: - 1. **Alex** - - **Interview** : [Watch now](https://www.youtube.com/watch?v=U-cGNG3rzPg) - - **LinkedIn** : [Alex's LinkedIn](https://www.linkedin.com/in/alex-seregin/) - - **Discord** : alexeusgr - - 2. **Bernand** - - **Interview** : [Watch now](https://www.youtube.com/watch?v=grbX5DAaW5Q) - - **LinkedIn** : [Bernand's LinkedIn](https://www.linkedin.com/in/bernard-sibanda-954563243/) - - **Discord** : wims5274 - - 3. **Suganya** - - **Interview** : [Watch now](https://www.youtube.com/watch?v=o8a6gTcE50w) - - **LinkedIn** : [Suganya's LinkedIn](https://www.linkedin.com/in/suganya-raju/) - - **Discord** : suganya1607 - - 4. **Udai** - - **Interview** : [Watch now](https://www.youtube.com/watch?v=UDXshRpVA6M) - - **LinkedIn** : [Udai's LinkedIn](https://www.linkedin.com/in/solanki/) - - **Discord** : thecoder0001 -## Contact & Communication - -- **GitHub Discussions**: [Developer-Experience Working Group Repository](https://github.com/IntersectMBO/developer-experience/discussions) -- **Discord Channel**: [OSC- Working Groups](https://discord.com/channels/1136727663583698984/1239886460266479696) -- **Email**: [Open Source Office](oso@intersectmbo.org) - -## Contributing Guidelines -- Please checkout our [Contributing Documentation](./CONTRIBUTING.md). -- Read our Code of Conduct. -- Check existing issues before creating new ones. -- Provide clear, detailed descriptions. -- Follow our template in `CONTRIBUTING.md` for issues and pull requests. -- Be respectful and constructive. +
+ +# Developer Experience Working Group + +**Making Cardano development more accessible, efficient, and rewarding** + +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![Cardano](https://img.shields.io/badge/Cardano-Ecosystem-0033AD?logo=cardano)](https://cardano.org) +[![Intersect MBO](https://img.shields.io/badge/Intersect-MBO-00B4D8)](https://www.intersectmbo.org/) +[![Documentation](https://img.shields.io/badge/docs-Docusaurus-2E7D32)](https://devex.intersectmbo.org/) + +**[Website](https://devex.intersectmbo.org/)** · **[Report an issue](https://github.com/IntersectMBO/developer-experience/issues)** · **[Discussions](https://github.com/IntersectMBO/developer-experience/discussions)** + +
+ +--- + +## Project overview + +The **Developer Experience (DevEx) Working Group** is a community of Developer Advocates from **Intersect MBO** focused on improving how developers build on Cardano. We identify pain points, improve tooling and documentation, and foster collaboration across the ecosystem so that onboarding and day-to-day development are clearer and faster. + +| Aspect | Description | +|--------|-------------| +| **Mission** | Enhance developer experience in the Cardano ecosystem so more people can build successfully. | +| **Scope** | Documentation, tooling, workflows, onboarding, and the human side of developer experience. | +| **Output** | This repo: docs, guides, working group materials, and a [Docusaurus documentation site](https://devex.intersectmbo.org/). | + +> **Who is this for?** Developers (new or experienced), project maintainers, and anyone who wants to contribute to or improve Cardano’s developer experience. + +--- + +## What we do + +- **Identify and prioritize** developer experience issues in the Cardano ecosystem. +- **Propose and implement** improvements to tooling, documentation, and workflows. +- **Foster collaboration** between developers, projects, and stakeholders. +- **Support multi-language** integration and learning paths. +- **Develop a Developer Thriving Framework** to address social barriers and engagement. +- **Focus on the human side** of developer experience, not only docs and tech. +- **Run collaborative workshops** to gather perspectives and build shared understanding. +- **Address pain points** that block newcomers and growth. +- **Build trust and reduce silos** across the developer community. + +--- + +## Focus areas + +| Area | Description | +|------|-------------| +| **Onboarding & documentation** | Clear getting-started guides and up-to-date references. | +| **Tooling & workflows** | Better dev tools and day-to-day workflows. | +| **Collaboration** | Working with other developers and projects in the ecosystem. | +| **Feedback** | Collecting and acting on developer feedback. | +| **Community & knowledge sharing** | Support channels and shared learning. | + +--- + +## Get involved + +| Channel | Link | +|---------|------| +| **Calendar** | [Intersect Event calendar](https://calendar.google.com/calendar/u/1?cid=Y19iMGMyODE3NWE2NTBkOGUwNzIwNTM2ZGU4OWE0NDMxMjFiYTcxYTVkMDgxYmRiOWU1NGRiZTU2NjI1NGY5ZGUwQGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20) — weekly DevEx sessions. | +| **GitHub** | [Issues](https://github.com/IntersectMBO/developer-experience/issues) · [Pull requests](https://github.com/IntersectMBO/developer-experience/pulls) · [Discussions](https://github.com/IntersectMBO/developer-experience/discussions). | +| **Membership** | [Become an Intersect member](https://members.intersectmbo.org/registration). | +| **Discord** | [DevEx WG channel](https://discord.com/channels/1136727663583698984/1250047836339306526). | +| **Feedback** | Share ideas and pain points in Discord or via GitHub issues. | + +--- + +## Developer advocates + +Connect with current and past advocates for help, calls, or questions. + +### Current cohort + +| Advocate | LinkedIn | Schedule a call | X | Discord | +|----------|----------|-----------------|---|--------| +| **Uche** | [Profile](https://www.linkedin.com/in/thisisobate) | [Book](https://calendar.app.google/6HC9yHfTHrQ1dfcB9) | - | @obate. | +| **Emmanuel** | [Profile](https://www.linkedin.com/in/emmanuel-shikuku-devops/) | [Book](https://calendar.app.google/3LGaFshgi7q9fsQD8) | [@Emmanuel_tyty](https://x.com/Emmanuel_tyty) | @emmanueltyty | +| **Dan** | [Profile](https://www.linkedin.com/in/danbaruka/) | [Book](https://calendar.app.google/T1BuH5EnRDyMTsyV8) | [@danamphred](https://x.com/danamphred) | @danamphred | +| **Harun** | [Profile](https://www.linkedin.com/in/harunslinked/) | [Book](https://calendly.com/harunm28/30min) | - | @wesh09 | + +### Past cohort + +| Advocate | Interview | LinkedIn | Discord | +|----------|-----------|----------|---------| +| **Alex** | [Watch](https://www.youtube.com/watch?v=U-cGNG3rzPg) | [Profile](https://www.linkedin.com/in/alex-seregin/) | alexeusgr | +| **Bernand** | [Watch](https://www.youtube.com/watch?v=grbX5DAaW5Q) | [Profile](https://www.linkedin.com/in/bernard-sibanda-954563243/) | wims5274 | +| **Suganya** | [Watch](https://www.youtube.com/watch?v=o8a6gTcE50w) | [Profile](https://www.linkedin.com/in/suganya-raju/) | suganya1607 | +| **Udai** | [Watch](https://www.youtube.com/watch?v=UDXshRpVA6M) | [Profile](https://www.linkedin.com/in/solanki/) | thecoder0001 | + +--- + +## Quick start + +Get the documentation site running locally in a few minutes. + +**Prerequisites:** [Node.js](https://nodejs.org/) (v18+ recommended), npm or yarn, Git. + +```bash +# Clone the repository +git clone https://github.com/IntersectMBO/developer-experience.git +cd developer-experience/website + +# Install dependencies +npm install + +# Start the dev server (hot reload) +npm run start:dev +``` + +Then open **http://localhost:3000** in your browser. You should see the DevEx site; edits under `website/docs` will reload automatically. + +| Goal | Command | +|------|--------| +| **Develop with live reload** | `npm run start:dev` | +| **Production build** | `npm run build` | +| **Serve production build** | `npm run serve` | + +--- + +## Installation & setup + +### Step 1: Clone and enter the website + +```bash +git clone https://github.com/IntersectMBO/developer-experience.git +cd developer-experience/website +``` + +### Step 2: Install dependencies + +```bash +npm install +``` + +### Step 3: Run the site + +- **Development (recommended):** `npm run start:dev` - starts Docusaurus with hot reload. +- **Production-style:** `npm run build && npm run serve` - build and serve the static site. + +### Step 4: Edit content + +- **Docs:** `website/docs/` - add or edit Markdown/MDX files; structure follows the sidebar. +- **Config:** `website/docusaurus.config.ts` - site title, theme, nav, footer. +- **Homepage:** `website/src/pages/index.tsx` (and related components). + +### Requirements + +| Requirement | Notes | +|-------------|--------| +| **Node.js** | v18 or higher (LTS recommended). | +| **npm or yarn** | For installing dependencies. | +| **Git** | For cloning and contributing. | --- -**Disclaimer**: This working group is community-driven and supported by Intersect MBO. We welcome contributions from all skill levels and backgrounds. +## Project structure + +``` +developer-experience/ +├── README.md # This file +├── CONTRIBUTING.md # How to contribute (issues, PRs, style) +├── LICENSE # Apache-2.0 +│ +├── website/ # Docusaurus documentation site +│ ├── docs/ # All documentation (Markdown/MDX) +│ │ ├── resources/ # Repos, tools, community, pathway +│ │ ├── working-group/ # Working group sessions & materials +│ │ └── ... # Guides, how-tos, getting started +│ ├── src/ # Custom React components, CSS, pages +│ ├── static/ # Static assets +│ ├── docusaurus.config.ts # Site configuration +│ └── package.json # Scripts: start:dev, build, serve +│ +└── .github/ # PR/issue templates, workflows +``` + +--- + +## Contributing + +We welcome contributions from all skill levels and backgrounds. + +1. **Read** [CONTRIBUTING.md](./CONTRIBUTING.md) for full guidelines (setup, style, PR process). +2. **Check** [existing issues](https://github.com/IntersectMBO/developer-experience/issues) before opening new ones. +3. **Use** the issue and PR templates; provide clear descriptions. +4. **Be respectful and constructive** in discussions and reviews. + +Quick contribution flow: fork → branch → edit (e.g. under `website/docs/`) → test locally (`npm run start:dev`) → open a PR. + +--- + +## Contact + +| Channel | Link | +|---------|------| +| **GitHub Discussions** | [Developer Experience WG](https://github.com/IntersectMBO/developer-experience/discussions) | +| **Discord** | [OSC Working Groups](https://discord.com/channels/1136727663583698984/1239886460266479696) | +| **Email** | [Open Source Office](mailto:oso@intersectmbo.org) | + +--- + +
+ +**This working group is community-driven and supported by Intersect MBO.** +*We welcome contributions from all skill levels and backgrounds.* +