a2c4161477
* docs: process docs to include UX Stories requirement * docs: include note regarding different environments * Services init * Remove unused canny logos * docs: add ModalService diagram * docs: GIF of notification * docs: add ui-services page * docs: simplify ui services call out in the general services docs * docs: tips and tricks for UI services * docs: moar pages * docs: dialog gif * docs: services in summary/sidebar * docs: gif examples at top of dialog and notification pages * docs: add UIModal gif * docs: details for Dialog Service * docs: include usage information for ui modal service * docs: detailed information about our UI Notification Service * docs: services diagram * docs: remove unused links * docs: services example and image |
||
|---|---|---|
| .. | ||
| latest | ||
| v1 | ||
| _redirects | ||
| .gitignore | ||
| CNAME | ||
| README.md | ||
| win-server-workaround.bat | ||
How To: Documentation Step-by-Step
We use GitBook to create our documentation. It primarily uses markdown, html, css, js, misc. plugins, and configuration to generate high quality, easy to read, and easy to maintain documentation.
Getting Started
Requirements:
Make sure you have the gitbook-cli installed globally:
npm install -g gitbook-cli
Editing and Previewing Changes
Currently, you can only edit and preview a single "book" at a time. We maintain one "book" per API major version. You can find each version's book at:
Past Versions:
- Template:
<project-root>/docs/v<versionNumber>
- Examples:
/docs/v1/docs/v2
Latest Version:
The latest version will always be located in /docs/latest
Live Preview:
In your terminal / command prompt:
cd /docs/latest
gitbook install
gitbook serve
Which should generate output like:
starting server... serving book on http://localhost:4000
Navigating to the the provided URL will show a preview of what the generated book should look like. Any edits you make to the book's markdown files should automatically update in your browser.