platformOS Developer Portal - Event Recap

API The Docs Virtual 2021 Showcase Your Devportal

This demo was presented at API The Docs Virtual 2021 Showcase Your Devportal event series on 20 October. We are glad to present the video recording of the event with the demo and the Q&A session. Enjoy!

Visit the Showcase Your DevPortal Recap page for summaries and recordings.



In the demo, you can hear about:

  • Content production for platformOS Developer Portal
  • Onboarding documentation and different style guides for different audiences
  • Accessibility and inclusive language
  • Templates for each type of topics with non-changeable content, placeholders, and examples
  • Best practices for building a developer documentation site on platformOS
  • Editorial workflow, continuous integration & delivery, automated tests & analytics

platformOS Developer Portal


Diana Lakatos (Director of Documentation),
Adam Broadway (CEO)


The platformOS Developer Portal provides comprehensive onboarding journeys to the three main segments of our target audience: Non-technical users, Semi-technical users, Technical users. We regularly test for accessibility with various tools and ensure that the site complies with all accessibility requirements. We implemented a complete docs as code workflow on GitHub and took it even further by incorporating issue tracking and project management. Our editorial workflow ensures that contribution works the same way for everyone, and we support our contributors with a Contributor Guide, a Style Guide, and Markdown templates for each type of content.

Read more on platformOS's Devportal Awards nomination page.

Q&A

  • What are the most used parts?
  • Are code samples in documentation tested as part of CI pipeline?
  • What kind of participation in docs do you gain through open sourcing docs?

Sign up to our Developer Portal Newsletter so that you never miss out on the latest API The Docs recaps and our devportal, API documentation and Developer Experience research publications.