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
% pip install mkdocs-ringcentral
% mkdocs serve
Then you should be able to load http://localhost:8000 to view the documentation.
For local development, mkdocs uses a RingCentral Mkdocs Theme. If you wish to affect the underlying structure of the site you have two choices:
- Override locally
- Fix globally
To override locally, consult the mkdocs documentation on creating a custom theme. The process involves overriding theme files with your own custom files. This requires you understand the underlying theme structure, so consult the structure of mkdocs-ringcentral.
To make a change globally, you can also submit a pull request to mkdocs-ringcentral and the change can be propogated across all documentation projects that utilize it.
Our documentation is all based on the open-source CSS framework called Bootstrap. It makes available a number of commonly used UI components that can be cut and paste into our docs and be rendered faithfully.
- Visit the Bootstrap Component Library to learn more
Our documentation also makes use of the Mkdocs Material Plugin. This plugin is what renders admonitions for example.
!!! note "Phasellus posuere in sem ut cursus"
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod.
This plugin extends the markdown language new ways of encoding text in markdown, including:
There are a number of other Markdown extensions available through Material as well.