Skip to content
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

Merged
merged 11 commits into from
Sep 29, 2020
Merged

Conversation

blackonyyx
Copy link

Preliminary version.

…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.
usecases.

Usecases are to derive from Personas in a seperate file.

To resolve stuff
@blackonyyx blackonyyx added the type.Documentation Documentation addition/update. label Sep 23, 2020
@blackonyyx blackonyyx added this to the v1.1 milestone Sep 23, 2020
@codecov-commenter
Copy link

codecov-commenter commented Sep 23, 2020

Codecov Report

Merging #22 into master will increase coverage by 1.33%.
The diff coverage is n/a.

Impacted file tree graph

@@             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     
Impacted Files Coverage Δ Complexity Δ
...java/seedu/address/logic/commands/EditCommand.java 97.01% <ø> (ø) 12.00 <0.00> (ø)
.../seedu/address/logic/parser/AddressBookParser.java 100.00% <ø> (ø) 12.00 <0.00> (ø)
...c/main/java/seedu/address/model/person/Person.java 97.56% <ø> (ø) 21.00 <0.00> (ø)
src/main/java/seedu/address/ui/PersonCard.java 0.00% <ø> (ø) 0.00 <0.00> (ø)
...java/seedu/address/logic/parser/InvParserUtil.java 72.72% <0.00%> (+12.12%) 9.00% <0.00%> (+2.00%)
.../java/seedu/address/model/item/UniqueItemList.java 87.80% <0.00%> (+48.78%) 20.00% <0.00%> (+11.00%)
...s/model/item/exceptions/ItemNotFoundException.java 100.00% <0.00%> (+100.00%) 1.00% <0.00%> (+1.00%)
.../model/item/exceptions/DuplicateItemException.java 100.00% <0.00%> (+100.00%) 1.00% <0.00%> (+1.00%)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1390ef3...a93bea9. Read the comment docs.

Copy link

@aqcd aqcd left a 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.

docs/AboutUs.md Outdated Show resolved Hide resolved
docs/AboutUs.md Outdated Show resolved Hide resolved
docs/AboutUs.md Outdated Show resolved Hide resolved
docs/AboutUs.md Outdated Show resolved Hide resolved
docs/DeveloperGuide.md Outdated Show resolved Hide resolved
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.
Copy link

@justacasul justacasul left a 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)

build/resources/main/view/PersonListCard.fxml Show resolved Hide resolved
@@ -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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about recipes?

Copy link
Author

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

docs/DeveloperGuide.md Outdated Show resolved Hide resolved
docs/Testing.md Outdated Show resolved Hide resolved
docs/Testing.md Outdated Show resolved Hide resolved
docs/team/liuzhendao.md Outdated Show resolved Hide resolved
docs/DeveloperGuide.md Outdated Show resolved Hide resolved
docs/DeveloperGuide.md Show resolved Hide resolved
docs/DeveloperGuide.md Show resolved Hide resolved
docs/DeveloperGuide.md Show resolved Hide resolved
@blackonyyx blackonyyx self-assigned this Sep 27, 2020
Copy link

@aqcd aqcd left a 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).

docs/AboutUs.md Outdated Show resolved Hide resolved
docs/AboutUs.md Outdated Show resolved Hide resolved
docs/CommandSequenceDiagram.md Outdated Show resolved Hide resolved
docs/DeveloperGuide.md Outdated Show resolved Hide resolved
docs/DeveloperGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/team/liuzhengdao.md Outdated Show resolved Hide resolved
Copy link

@aqcd aqcd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@aqcd aqcd merged commit acac987 into AY2021S1-CS2103T-F13-1:master Sep 29, 2020
blackonyyx added a commit that referenced this pull request Nov 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type.Documentation Documentation addition/update.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants