Skip to content

Commit

Permalink
Merge pull request ringcentral#47 from ringcentral/addGitHubPage
Browse files Browse the repository at this point in the history
Setup GitHub Pages
  • Loading branch information
SushilMallRC authored Apr 10, 2024
2 parents 69a58fe + b6fd269 commit f40aecb
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/release-github-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: GitHub Pages release
on:
push:
branches:
- master
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version}}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
4 changes: 4 additions & 0 deletions docs/app-registration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

# Registering your application

Before you begin development, you will first need to register your application via the RingCentral Developer Console. This step will provision your application a unique set of credentials used to identify your application on the network, and comes with the benefits listed below.
23 changes: 23 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Home

[![Build Status](https://github.com/ringcentral/ringcentral-java/actions/workflows/test.yml/badge.svg)](https://github.com/ringcentral/ringcentral-java/actions)
[![Coverage Status](https://coveralls.io/repos/github/ringcentral/ringcentral-java/badge.svg?branch=master)](https://coveralls.io/github/ringcentral/ringcentral-java?branch=master)
[![Reference](https://img.shields.io/badge/Javadoc-reference-blue?logo=java)](https://ringcentral.github.io/ringcentral-java/)
[![Chat](https://img.shields.io/badge/chat-on%20glip-orange.svg)](https://ringcentral.github.io/join-ringcentral/)
[![Twitter](https://img.shields.io/twitter/follow/ringcentraldevs.svg?style=social&label=follow)](https://twitter.com/RingCentralDevs)

__[RingCentral Developers](https://developer.ringcentral.com/api-products)__ is a cloud communications platform which
can be accessed via more than 70 APIs. The platform's main capabilities include technologies that enable:

* [Voice](https://developer.ringcentral.com/api-products/voice)
* [SMS/MMS](https://developer.ringcentral.com/api-products/sms)
* [Fax](https://developer.ringcentral.com/api-products/fax)
* [Team Messaging](https://developer.ringcentral.com/api-products/team-messaging)
* [Data and Configurations](https://developer.ringcentral.com/api-products/configuration)
* [Video](https://developers.ringcentral.com/video-api)
* [RingSense AI](https://developers.ringcentral.com/ai-api)
* [Webinar](https://developers.ringcentral.com/webinar-api)
* [Business Analytics](https://developers.ringcentral.com/analytics-api).

[API Reference](https://developer.ringcentral.com/api-docs/latest/index.html)
and [APIs Explorer](https://developer.ringcentral.com/api-explorer/latest/index.html).
41 changes: 41 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
site_name: RingCentral Java SDK
theme:
name: material
features:
- navigation.path
- navigation.tabs
- navigation.top
- navigation.expand
- navigation.sections
- search.sharing
- search.highlight
- content.code.copy
- content.action.edit
- content.action.view
- content.code.annotate
palette:
- scheme: default
primary: custom
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- scheme: slate
primary: black
accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono

plugins:
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- badges
- social
- exclude:
regex:
- '^\.#.*'
- '.*\.\#.*$'

0 comments on commit f40aecb

Please sign in to comment.