Discover this podcast and so much more

Podcasts are free to enjoy without a subscription. We also offer ebooks, audiobooks, and so much more for just $11.99/month.

#21: Awesome Developer Documentation for your OSS Project

#21: Awesome Developer Documentation for your OSS Project

FromTOPP - The Open Podcast Podcast


#21: Awesome Developer Documentation for your OSS Project

FromTOPP - The Open Podcast Podcast

ratings:
Length:
19 minutes
Released:
Jan 31, 2023
Format:
Podcast episode

Description

How did you like this episode??(upvote)  ? (downvote)We describe our stack for writing documentation and which tools we can recommend to improve yours.One of a user’s first points of contact with your project will be through your project documentation. Even open source projects should try to make a good first impression here, but how exactly do you write great docs?Nowadays there are a gazillion different tools to write developer documentation. To save you some time, we’ll try to give you an overview and explain what worked for us and what didn’t.LinksReadme.com (https://readme.com/) Excalidraw (https://excalidraw.com/)Mermaid (https://mermaid.js.org )Docsify (https://docsify.js.org/#/)Our docs (https://openpodcast.dev/#/?id=main)HostsMatthias Endler (https://mastodon.social/@mre) Wolfgang Gassler (https://twitter.com/schafele)FeedbackEmail: echo@openpodcast.dev Twitter: https://twitter.com/OpenPodcastDev CreditsThe theme music is U.S. Army Blues - Kelly’s Number and is licensed under Public Domain Mark 1.0 License. How did you like this episode??(upvote)  ? (downvote)
Released:
Jan 31, 2023
Format:
Podcast episode

Titles in the series (23)

“The Open Podcast Podcast”, a weekly show about the Podcast Ecosystem and our attempt to build an open source analytics platform for podcast hosts. We believe that the Podcast ecosystem needs to remain open. Contrary to what some proprietary platforms believe, we think people value freedom and open standards. We believe that Podcast hosts can grow an audience without locking people in or being dependent on the big players. In this podcast we talk about ideas on how to make the podcast ecosystem more open and how we actively contributing to it by working on our project "Open Podcast"