Documentation
============================================

The goal of the API (Application Programming Interface) / SDK (Software Development Kit) Documentation is to give any developer with Python or RESTful experience the knowledge and understanding required to create applications using SyncSign's technology.

Get Started Immediately
-----------------------
Developers can use the :doc:`Sample Application <../getstarted/sdkapp_sample>` to immediately run code and see how the SDK can be used.

One of SyncSign and Hub will be required to run the sample application.

Introduction
-----------------------
SyncSign Display and Hub can be automated using the RESTful API or Hub SDK. This section introduces these products and introduces the API/SDK, and it's architecture.

- :doc:`hardware`
- :doc:`difference`
- :doc:`sdk`
- :doc:`api`

Concepts to Understand
-----------------------
SyncSign products use technologies that not all developers are familiar with. Understanding the concepts of these technologies will make development easier and allow developers to utilize the capability of SyncSign fully.

- :doc:`../concepts/basic`

Guides
-----------------------
Guides contain detailed information on product and SDK components. Most of the technologies and terminology used within the SDK is covered in these guides.

- :doc:`../guides/programming`
- :doc:`../guides/hub_app_basic`
- :doc:`../guides/render_layout`
- :doc:`../references/calendar_template_editing`

Development Workflow
-----------------------
From registering as a developer to deploying an application, this section will take developers through the full development process.

- :doc:`../workflow/prepare`
- :doc:`../workflow/upload`
- :doc:`../workflow/debug`
- :doc:`../workflow/release`

Tutorials
-----------------------
Several tutorials are provided as examples of how to use the SDK for different applications.

- :doc:`../tutorials/hello_world`
- :doc:`../tutorials/weather_station`
- :doc:`../tutorials/price_tags`

Sample Code
-----------------------
Contains all examples mentioned in this document.

- :doc:`../samples/links`

SDK/API Reference
-----------------------
Full SDK / API descriptions are available.

- :doc:`../references/hub`

FAQ
-----------------------
Frequently asked questions asked by developers can be found :doc:`here <../support/faq>`.