Skip to content

README.md

Latest commit

 

History

History
151 lines (97 loc) · 4.1 KB

README.md

File metadata and controls

151 lines (97 loc) · 4.1 KB

Developer Relations Knowledge Base

License: CC BY 4.0

A community-maintained hub of DevRel best practices, guides, and resources in the field of Developer Relations.

Project Purpose

The goal is to co-create a living, evolving resource that documents Developer Relations concepts, strategies, and experiences—built by the DXMentorship community, for the global tech ecosystem. It will showcase the collective knowledge and serve as a high-value project members can add to their portfolios.

Contributing to DX DevRel Guide

Thanks for your interest in contributing! Here's how to get started:

🧰 Setup

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/yourusername/dx-devrel-guide.git
  3. Install the Mintlify CLI to preview the documentation changes locally: npm i -g mintlify
  4. Start the dev server: mintlify dev

✍️ Writing Content

  • All docs are in the docs/ folder.
  • Follow the file naming conventions: lowercase-with-dashes.mdx
  • Use --- frontmatter for the title, e.g.:
---
title: Developer Advocacy
---

## Public Speaking

...

📋 Contribution Topics Checklist

Choose a topic to contribute to with the topic name and assign yourself. Add your name when you start working on them.

0. Welcome & Introduction

  • What is DXMentorship?
  • Purpose of this guide
  • How to contribute

1. What is Developer Relations?

  • Definitions & origins - assigned to Faith
  • Core pillars: Advocacy, Enablement, Community, Feedback Loops
  • Why DevRel matters

2. Developer Advocacy

  • Public speaking
  • Content creation (blogs, videos, docs)
  • Developer champions

3. Developer Experience

  • Tooling & DX audits
  • Documentation best practices
  • Feedback collection

4. Community Building

  • Events & meetups
  • Online community management
  • Onboarding and retention strategies

5. Measuring DevRel Impact

  • KPIs & OKRs
  • Qualitative vs. Quantitative metrics
  • Reporting to leadership

6. Career Pathways in DevRel

  • Roles in DevRel (Advocate, Educator, Manager, etc.)
  • Skills & tools
  • Breaking into DevRel

7. Case Studies & Stories

  • Real-life examples from the community
  • Lessons learned
  • Tools we love

8. Resources & Further Reading

  • Books
  • Podcasts
  • Communities to join
  • Courses

9. Community Authors

  • List of contributors
  • GitHub profiles
  • LinkedIn/portfolio links
  • Jobs in DevRel

👥 Adding Yourself as a Contributor

We appreciate all contributors! To add yourself:

  1. Add your profile photo (square format recommended) to public/images/contributors/ with filename format firstname-lastname.jpg
  2. Edit community-authors.mdx and add your card to the CardGroup following the template in the file.

✨ Bonus: Breakdown of an .mdx Page

Here's a starter for developer-advocacy.mdx:

---
title: Developer Advocacy
---

## Public Speaking

How DevRel professionals speak at conferences to build awareness and trust.

## Content Creation

Creating blog posts, videos, and tutorials.

## Developer Champions

Empowering community members to represent the product.

How Everyone Can Contribute

We'll run the documentation effort like a mini open-source project:

  1. Each contributor selects a section to work on (from the checklist above).
  2. Contributors submit pull requests via GitHub.
  3. Clan leads and reviewers provide feedback and merge updates.
  4. Contributors are listed in the "Community Authors" section with links to their profiles.
  5. Daily check-ins will help us track progress, support contributors, and celebrate wins.

Our Top Contributors ✨

DxDevRel Guides wouldn't be DxDevRel Guides without you. Every contribution counts. Thank you for being part of this journey.