The Changelog avatar

Dexa/The Changelog

Learn more
Published Feb 9, 2018

Devhints - TL;DR for Developer Documentation

Rico Sta. Cruz delves into the world of developer documentation and open source, discussing his tools Devhints, Docpress, and Flat Doc, while shedding light on the importance of community engagement and collaboration within the Filipino developer community.
Episode Highlights
The Changelog logo

Topics covered

Popular Clips

Episode Highlights

  • Docpress & Flat Doc

    Rico Sta. Cruz discusses the differences between Docpress and Flat Doc, two documentation tools he developed. Docpress is designed for creating websites from markdown files, making it simple and extensible, while Flat Doc is more suited for smaller projects that fit on a single page 1. Rico appreciates the collaborative nature of these projects, acknowledging that other tools like GitBook might offer better features, but he values being part of a global effort to improve documentation tools 1.

    It's humbling to be part of that collective effort of many people across the globe just honing an idea, making implementations of it.

    ---

    Both tools reflect his design skills, offering clean and responsive themes that enhance user experience 2.

       

    Cheat Sheets

    Devhints, a project by Rico, has evolved from a simple markdown repository to a comprehensive website offering cheat sheets for developers. Initially, it was just a personal collection of notes, but as it gained popularity, Rico transformed it into a full-fledged platform 3. The ease of creating new cheat sheets is a key feature, allowing users to quickly generate content using markdown 4.

    I basically just want to go from idea to cheat sheet just by opening vim, typing a couple of things out, and then suddenly it's a cheat sheet.

    ---

    This simplicity has contributed to its widespread use and community engagement.

       

    Community Collaboration

    Devhints thrives on community contributions, with its open-source nature allowing for collaborative markdown editing. Rico manages numerous pull requests, welcoming contributions ranging from typo corrections to new cheat sheets 5. The project has attracted notable contributors, such as José Valim, who have added valuable content to the platform 6.

    There's a lot of contributions into devhints. A lot of people would contribute anything from small typo changes to new sections to totally new cheat sheets.

    ---

    This collaborative spirit ensures that Devhints remains a dynamic and evolving resource for developers.

Related Episodes