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

Update User Guide and Developer Guide #127

Merged
merged 59 commits into from
Oct 22, 2020
Merged

Update User Guide and Developer Guide #127

merged 59 commits into from
Oct 22, 2020

Conversation

sebastiantoh
Copy link

@sebastiantoh sebastiantoh commented Oct 20, 2020

📔 This PR contains work from multiple team members and is not solely my (Sebastian) work

Changes:

  • Introduction

  • Design

    • Sebastian: Updated example used in ArchitectureSequenceDiagram and DeleteSequenceDiagram
      • delete 1 -> contact delete 1
    • Sebastian: Updated Model UML diagram to include reminders and meetings
    • Min Yih: Updated Model UML diagram to include sales
    • Sebastian: Updated Storage UML diagram to include reminders and meetings
    • Min Yih: Updated Storage UML diagram to include sales
  • Implementation

    • Sebastian: Updated Implementation section to include some meeting implementation details
    • Min Yih: Updated Implementation section to include some sale implementation details

Future Improvements:

  • UML diagram for Logic is inaccurate, specifically the part for the Parser since we made some amendments / refactoring
  • The current DG makes reference to StonksBookParser. I'm not sure if we should rename AddressBookParser to StonksBookParser, and then update the UML diagrams
  • Maybe can consider deleting the section [Proposed] Undo/redo feature and [Proposed] Data archiving
  • Update Appendix: Instructions for manual testing

@codecov-io
Copy link

codecov-io commented Oct 20, 2020

Codecov Report

Merging #127 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #127   +/-   ##
=========================================
  Coverage     75.03%   75.03%           
  Complexity     1147     1147           
=========================================
  Files           161      161           
  Lines          3633     3633           
  Branches        496      496           
=========================================
  Hits           2726     2726           
  Misses          734      734           
  Partials        173      173           

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 f2c7c25...2c07c4a. Read the comment docs.

@Asthenosphere Asthenosphere added this to the UG/DG Peer Review milestone Oct 22, 2020
@sebastiantoh sebastiantoh marked this pull request as ready for review October 22, 2020 14:03
@sebastiantoh sebastiantoh requested a review from a team October 22, 2020 14:04
…into docs

# Conflicts:
#	docs/DeveloperGuide.md
#	docs/UserGuide.md
Copy link

@Asthenosphere Asthenosphere left a comment

Choose a reason for hiding this comment

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

Thanks @sebastiantoh for updating the docs! LGTM!

@Asthenosphere Asthenosphere merged commit 9ca0024 into master Oct 22, 2020
@sebastiantoh sebastiantoh deleted the docs branch November 8, 2020 02:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants