-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Developer Guide (#12) #22
Conversation
…late the Inventoryinator documentation. This provides a base of documentation for future additions and testing Currently some parts may still be using AddressBook3 notation but will be iteratively removed out of the documentation.
portions of Inventoryinator Documentation.
usecases. Usecases are to derive from Personas in a seperate file. To resolve stuff
Codecov Report
@@ Coverage Diff @@
## master #22 +/- ##
============================================
+ Coverage 54.10% 55.43% +1.33%
- Complexity 479 494 +15
============================================
Files 101 101
Lines 2024 2024
Branches 190 190
============================================
+ Hits 1095 1122 +27
+ Misses 879 855 -24
+ Partials 50 47 -3
Continue to review full report at Codecov.
|
cf7a5b4
to
dbfa09e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Preliminary review. Will do deeper checks on finalised version.
Guide This will utilise assets previously created but not utilised.
Add new images, amend README.md to include logo, this will improve meme-value Add headers of documentation to all md files. This makes it clearer as to what is happening in these Documents. Reorganisation of assets, assest have been moved to more relevent file directories. Makes it easier to navigate and link images in documentation. Deletion of AB3 Documentation. Deletion of Irrelevent and Boilerplate Documentation from AB3 such as Tutorials.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing big, just change up some .png(s)
@@ -202,155 +217,72 @@ The following activity diagram summarizes what happens when a user executes a ne | |||
|
|||
##### Aspect: How undo & redo executes | |||
|
|||
* **Alternative 1 (current choice):** Saves the entire address book. | |||
* **Alternative 1 (current choice):** Saves the entire inventory. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about recipes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inventory is meant to refer to entire state of the inventoryinator. will add term to glossary
Add white space to Testing.md to pass CI
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mainly need to decide if you want to change del -> deli + delr currently since it will be that way for quite a while (until v1.2 or v1.3).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Preliminary version.