7c4ee734fa
* refactor: 💡 React components to consume appConfig using Context React components to consume app configuration using React Context and React Hooks. Non React components to continue using global variable window.config. Related documentation also changed. Closes: #725 * refactor: 💡 Removing unecessary code On current React component there is no need to import useContext method from React, so, removing it. * refactor: 💡 Code review Code review. Minor changes based on review inputs and moving userManager to an init method BREAKING CHANGE: #725 Closes: #725 * docs: don't include implementation detail in docs * docs: don't include implementation detail in docs * docs: no need to specify implementation details in employment recipe * docs: no need to specify implementation details in deployment recipe |
||
|---|---|---|
| .. | ||
| latest | ||
| v1 | ||
| .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.