Skip to content

Commit

Permalink
fix: applied rephrases
Browse files Browse the repository at this point in the history
  • Loading branch information
vickywane committed Jun 2, 2021
1 parent c61fcbf commit 76b2e9c
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 27 deletions.
38 changes: 19 additions & 19 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,22 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up Python 3.9
uses: actions/setup-python@v2
with:
python-version: 3.9
- name: Install dependencies
run: |
python -m pip install --upgrade pip
- name: Run build script
run: |
./build-docs.sh
- name: Deploy to github pages
# run this step only if its a push on the master(main) branch
# and not a PR from a fork
if: github.event_name == 'push'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
- uses: actions/checkout@v2
- name: Set up Python 3.9
uses: actions/setup-python@v2
with:
python-version: 3.9
- name: Install dependencies
run: |
python -m pip install --upgrade pip
- name: Run build script
run: |
./build-docs.sh
- name: Deploy to github pages
# run this step only if its a push on the master(main) branch
# and not a PR from a fork
if: github.event_name == 'push'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
13 changes: 6 additions & 7 deletions docs-md/users/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,6 @@ timeline screenshot.

![Timeline](../assets/images/timeline-screen.png)

### Ambianic Premium Services

Ambianic provides premium value added services at a fixed price of $5 for users want to
get extra pre-configured features from Ambianic in the quickest time possible.

Read on: [Using Ambianic Premium Services](premium-services.md)

### Pairing Ambianic UI with Ambianic Edge

You can easily pair up your Ambianic UI with Ambianic Edge. It works similar to Airdrop.
Expand All @@ -105,6 +98,12 @@ The pairing information is persisted on your Ambianic UI client device and you c

When you are ready to explore more advanced capabilities, continue to the next section.

### Ambianic Premium Services

Ambianic provides premium value added services such as email notifications for users who prefer the convenience of automatic integration with third party cloud services.

Read on: [Using Ambianic Premium Services](premium-services.md)

### Configuration

Ambianic provides flexible configuration options via a configuration YAML file. You can customize: pipelines, input sources, AI models, notification channels and more.
Expand Down
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ nav:
- Quick Start: users/quickstart.md
- Ambianic Box: users/ambianicbox.md
- Configuration: users/configure.md
- Premium Services: users/premium-services.md
# - FAQ: users/faq.md
# - Web UI: users/webui.md
# - Mobile UI: users/mobileui.md
Expand Down Expand Up @@ -34,7 +35,10 @@ nav:
- p2p architecture: https://webrtchacks.com/private-home-surveillance-with-the-webrtc-datachannel/
- peerjs-python: https://github.com/ambianic/peerjs-python
- ambianic-pnp: https://github.com/ambianic/ambianic-pnp

- Premium Service Cloud API:
- Cloud API Documentation: https://github.com/vickywane/ambianic-subscriptions.github.io/tree/main/openapi-docs#installation
- OpenAPI Documentation: https://ambianic.github.io/ambianic-subscriptions.github.io/

theme:
name: mkdocs
custom_dir: custom_theme/
Expand Down

0 comments on commit 76b2e9c

Please sign in to comment.