Added docs for Activity flow #2735
Conversation
aditya-07
force-pushed
the
ak/workflow-md
branch
from
509eb8c
to
ecbd1dd
Compare
Done |
Done |
| @@ -0,0 +1,20 @@ | |||
| # Demo App | |||
|
|
|||
| To demonstrate the capabilities of the Activity Flow api, we have created the *Workflow Demo* app. The app has a Patient card in the top showing the details and a carousel in the bottom with each card representing a particular phase of the activity flow. | |||
There was a problem hiding this comment.
| To demonstrate the capabilities of the Activity Flow api, we have created the *Workflow Demo* app. The app has a Patient card in the top showing the details and a carousel in the bottom with each card representing a particular phase of the activity flow. | |
| The *Workflow Demo* app demonstrates the capabilities of the Activity Flow API. The app has a Patient card in the top showing the details and a carousel in the bottom with each card representing a particular phase of the activity flow. |
optionally: The Workflow Demo app demonstrates the capabilities of CarePlan Generation API and the Activity Flow API.
| ./gradlew :workflow_demo:installDebug | ||
| ``` | ||
|
|
||
| ## Steps |
| ``` | ||
|
|
||
| ## Steps | ||
| 1. Click on the Initialize button to install the required dependencies for an activity flow. The dependencies are already bundled in the assets folder of the workflow demo app. After the dependencies are successfully installed, Start Button becomes enabled in the Proposal card. |
There was a problem hiding this comment.
not sure what the best formatting is, but feels neater to either have the Intialize and Start text in quotes, or italic, or bold - can you check android dev documentation and try to be consistent (or pick one).
|
|
||
| ## Steps | ||
| 1. Click on the Initialize button to install the required dependencies for an activity flow. The dependencies are already bundled in the assets folder of the workflow demo app. After the dependencies are successfully installed, Start Button becomes enabled in the Proposal card. | ||
| 2. Now, click on the Start to generate a CarePlan which intern has a Proposal Resource. This resource is then used by the app to create a new Activity Flow and the Proposal card now shows the details of the resource with the Start button disabled now. The carousel auto moves to the next Phase Card i.e. Plan. |
There was a problem hiding this comment.
i woudl put the phase names in italic
| ## Steps | ||
| 1. Click on the Initialize button to install the required dependencies for an activity flow. The dependencies are already bundled in the assets folder of the workflow demo app. After the dependencies are successfully installed, Start Button becomes enabled in the Proposal card. | ||
| 2. Now, click on the Start to generate a CarePlan which intern has a Proposal Resource. This resource is then used by the app to create a new Activity Flow and the Proposal card now shows the details of the resource with the Start button disabled now. The carousel auto moves to the next Phase Card i.e. Plan. | ||
| 3. Follow the same step as above [2.] to move to the next phases. |
There was a problem hiding this comment.
Repeat step 2 to move forward through the phases.
| 1. Click on the Initialize button to install the required dependencies for an activity flow. The dependencies are already bundled in the assets folder of the workflow demo app. After the dependencies are successfully installed, Start Button becomes enabled in the Proposal card. | ||
| 2. Now, click on the Start to generate a CarePlan which intern has a Proposal Resource. This resource is then used by the app to create a new Activity Flow and the Proposal card now shows the details of the resource with the Start button disabled now. The carousel auto moves to the next Phase Card i.e. Plan. | ||
| 3. Follow the same step as above [2.] to move to the next phases. | ||
| 4. To restart the Activity click Restart Flow that removes all the resources related to the flow and moves the app back to step [2.]. |
There was a problem hiding this comment.
don't use [] if it doesn't link
| 4. To restart the Activity click Restart Flow that removes all the resources related to the flow and moves the app back to step [2.]. | ||
| 5. The overflow menu on the action bar may be used to switch between various Activities supported in the demo app. | ||
|
|
||
| [!Video](workflow_demo_app.mp4) |
There was a problem hiding this comment.
a gif might be a lightweight way to do this if video links are problematic
There was a problem hiding this comment.
can you change code to use a monospace font?
the vertical spacing of the code blocks are not always centre-aligned between two phaces
the update values and states - i wonder if it would look better not in boxes.
also - i always think things look a lot better if you add rounded corner and a very suble drop shadow.
| @@ -17,11 +19,14 @@ Future features of the library will provide support for Tasking and other Workfl | |||
| ## Next Steps | |||
|
|
|||
| * [Getting Started](Getting-Started.md) | |||
There was a problem hiding this comment.
i think we normally use sentence case instad of title case? can you double check and make it consistent
There was a problem hiding this comment.
pls add a section for the phase apis.
and then, maybe these different phrase transition apis can be grouped under the same heading in constrast with the phase apis.
IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).
Fixes #[issue number]
Description
Clear and concise code change description.
Alternative(s) considered
Have you considered any alternatives? And if so, why have you chosen the approach in this PR?
Type
Choose one: (Bug fix | Feature | Documentation | Testing | Code health | Builds | Releases | Other)
Screenshots (if applicable)
Checklist
./gradlew spotlessApplyand./gradlew spotlessCheckto check my code follows the style guide of this project../gradlew checkand./gradlew connectedCheckto test my changes locally.