8f2604509d
* Enable study prefetcher and expose configs * Fix progress for all images * Enable study loading listener * Add new default for displaying progress bar for series * Use events instead of redux to improve performance * Add documentation, resolve issues with different datasets * CR Updates * CR Updates * CR Updates & Resolve issue when activating both stack and study prefetch * Add upward and update display set logic * Add new behavior to prefetching orders * Rollback display set check and activate cache check * Remove prefetch check * Check if displayset has images * Debounce check cache events * Remove usued debounce flags * Ignore prefetching same image * Use new image instead of image rendered * Continue prefetch after cache check * Update prefetch logic after checking cache * Remove log * Update displayset count default to 3 * Update netlify config Co-authored-by: Alireza <ar.sedghi@gmail.com> |
||
|---|---|---|
| .. | ||
| 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.