This repository is the home of the RingCentral Developer Guide: a collection of materials, and documentation to help educate developers on how to build on top of the RingCentral platform.
This repository powers the production of two key resources:
RingCentral's Developer Guide is powered by Read the Docs, and makes up the bulk of this repository. To contribute to this documentation effort, start by looking at mydocs.yml
which powers the generation of the table of contents and points to the specific documents located within the docs
directory.
RingCentral's Tutorials index aggregates content found here, as well as content across the web. It is powered by tutorials.json
.
If you would like to contribute to the RingCentral documentation effort, fork this repository, make your desired edits and contributions, and issue a pull request accordingly.
% git clone https://github.com/ringcentral/ringcentral-api-docs.git
% cd ringcentral-api-docs
% pip install mkdocs
% mkdocs serve
Then you should be able to load http://localhost:8000 to view the documentation.