GitHub as a Landing Page | Lorna Jane Mitchell | API The Docs Amsterdam 2019
Channel: API the Docs
Date: 2019-11-04

"GitHub as a Landing Page" by Lorna Jane Mitchell, API The Docs Amsterdam 2019

Talk Description:
"Having a good README file in every GitHub project is a key ingredient of good developer experience, but what makes a good README? This session looks at the various types of projects you might want to create a README for, and offers examples of good README practice in each case. Making sure the purpose and status of the project is key, and directing users to your (beautiful and actively maintained) main documentation is definitely part of the deal. But we can do more to engage and inform developers that reach our projects this way, and this session will show you how. Recommended for everyone who wants to make the projects we create a welcoming place for users, however they find us."

API The Docs Amsterdam 2019 recaps: https://pronovix.com/event/api-docs-amsterdam-2019
---

API the Docs is an event for tech writers, API developers, product owners and developer evangelists who embrace documentation as a crucial aspect of a great developer experience. The conference is a great opportunity to share and discuss the latest best practices, strategies and new trends relevant to API documentation and developer portals.

Pronovix Developer Portals Newsletter:  http://bit.ly/devportals