Documentation is important. Whether you are documenting code, a website or an API, clear and concise documentation is key for developers to get full value from what you’re offering. Documentation helps beginners get started by providing step-by-step walkthroughs, sample code, and API responses. It helps veterans by providing a solid reference, time-saving shortcuts, and tips for optimization. We want to double-down on that value.
Dedicated GitHub Repository
Many companies have their documentation up on GitHub. This allows docs to be worked on out in the open and for the community to help contribute. We have been supporters of this movement, and are proud to announce that CircleCI Docs are now open-sourced. You can find them on GitHub at: https://github.com/circleci/circleci-docs.
Getting Started Today
CircleCI Docs are written in Markdown (GitHub Flavored Markdown specifically) and powered by Jekyll. This is a very common and simple setup. You can find instructions on how to get started in the README.md and information how how to add and edit docs in CONTRIBUTING.md.
Looking To The Future
We want the CircleCI community to be just as much a part of docs as we are. We’re working on adding more information and examples for programming languages such as Go (Golang), more guides on test suites, more examples of deployment to various providers, and improving our current docs to add greater value. We’re looking for feedback. If there’s a guide or clarification you’d like to see, please open a GitHub Issue. I’ll be attending Write the Docs North America 2016 where we can discuss CircleCI docs as well as docs in general and how to improve them for everybody.