Update Client Readme #1286
Merged
Update Client Readme #1286
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
waxlamp
previously approved these changes
Aug 19, 2022
Member
waxlamp
left a comment
There was a problem hiding this comment.
This is a great start. As we work on the software for various use cases, we will need to begin building in time to do more comprehensive architecture documentation that builds off of this.
client/README.md
Outdated
|
|
||
| ## DIVE Interface (/dive-common) | ||
|
|
||
| The DIVE interfaces handles the loading in Viewer.vue of data and manages the layout of components provided in `/src` and the state managment of the system through `useModeManager` |
Member
There was a problem hiding this comment.
Suggested change
| The DIVE interfaces handles the loading in Viewer.vue of data and manages the layout of components provided in `/src` and the state managment of the system through `useModeManager` | |
| The DIVE interfaces handle the loading in Viewer.vue of data and manage the layout of components provided in `/src` and the state management of the system through `useModeManager`. |
Co-authored-by: Roni Choudhury <2903332+waxlamp@users.noreply.github.com>
Co-authored-by: Roni Choudhury <2903332+waxlamp@users.noreply.github.com>
Co-authored-by: Roni Choudhury <2903332+waxlamp@users.noreply.github.com>
Co-authored-by: Roni Choudhury <2903332+waxlamp@users.noreply.github.com>
Co-authored-by: Roni Choudhury <2903332+waxlamp@users.noreply.github.com>
Co-authored-by: Roni Choudhury <2903332+waxlamp@users.noreply.github.com>
waxlamp
reviewed
Aug 23, 2022
waxlamp
previously approved these changes
Aug 23, 2022
Member
waxlamp
left a comment
There was a problem hiding this comment.
I think this is in a good spot (just accept the one suggestion I made, which merely contains some low-level corrections). Thanks Bryon!
Co-authored-by: Roni Choudhury <2903332+waxlamp@users.noreply.github.com>
waxlamp
approved these changes
Aug 23, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Tries to explain more about the client code in the README.
provides.