Documentation is often one of the most overlooked components of a developer product. It's also one of the most crucial: No matter how powerful a new platform may be, developers won't know how to use it without clear documentation.
Here at Parse, we've always been focused on making it incredibly easy for you to get started with the basics, and to quickly learn how to utilize more advanced features. A big part of this effort has manifested in our guides.
New Look and Feel
As you may have noticed, we recently launched a brand new look and feel for these guides — but that's not the only change we've made.
Open Source Docs
Today, we're pleased to share a new, open-source system for editing and maintaining our guides, so you can help us keep them accurate and up-to-date.
Over the years, many fixes to our docs have stemmed from bug reports from our community. Since we don't use a CMS for our guides, making changes requires an engineer to write code and then deploy it. This process hasn't been ideal for fixing a simple typo or adding a small point of clarification. We considered switching to one of the many CMS options, but we've always found that these didn't allow us to offer the best possible user experience to our developers.
So, we built our own solution using GitHub and Parse. All of our guides are now available in markdown at https://github.com/ParsePlatform/Docs. When we want to deploy the latest changes, we run a Background Job in Cloud Code that pulls all of the markdown files from GitHub, processes them, and stores the HTML in a Parse app. Then, when you're visiting one of our guide pages, we pull the content from Parse and show it all on the webpage.
If you find any mistakes or have ideas on how to make our docs better, you can submit a pull request directly from GitHub and we'll have the change deployed live in no time. We hope this new approach will help us continue to improve the quality of our docs by allowing all of you to share your opinions for making the guides even better.
So, have a suggestion? Hit the “Edit this section” link at the end of any section of our docs and send us a pull request now!