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

Add relevant screenshots to UG #276

Merged
merged 27 commits into from
Oct 30, 2020

Conversation

rtshkmr
Copy link
Member

@rtshkmr rtshkmr commented Oct 29, 2020

Description

As per title.

Fixes #

Testing

NIL

Remarks

@rtshkmr rtshkmr added type.documentation Improvements or additions to documentation priority.Medium Nice to have labels Oct 29, 2020
@rtshkmr rtshkmr added this to the v1.4 milestone Oct 29, 2020
@rtshkmr rtshkmr self-assigned this Oct 29, 2020
@rtshkmr rtshkmr added this to In progress in v1.4 via automation Oct 29, 2020
@codecov
Copy link

codecov bot commented Oct 29, 2020

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #276   +/-   ##
=========================================
  Coverage     87.14%   87.14%           
  Complexity      928      928           
=========================================
  Files           112      112           
  Lines          2420     2420           
  Branches        278      278           
=========================================
  Hits           2109     2109           
  Misses          233      233           
  Partials         78       78           

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 4b41d08...eb0ef08. Read the comment docs.

@rtshkmr rtshkmr marked this pull request as ready for review October 29, 2020 20:07
@rtshkmr rtshkmr requested review from qwoprocks, tankangliang, raysonkoh and LeeEnHao and removed request for qwoprocks and tankangliang October 29, 2020 20:07
Copy link

@raysonkoh raysonkoh left a comment

Choose a reason for hiding this comment

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

Did not find any major issues with the UG changes.

v1.4 automation moved this from In progress to Reviewer approved Oct 30, 2020
README.md Outdated Show resolved Hide resolved
Comment on lines 226 to 229
Your data automatically saved after every change. The file is saved in the ubiquitous `.json` format, which
allows you to edit the file manually without even opening **TBM** up.
The location for this file is `./data/tbmManager.json` (indicated at the bottom left of the window), where the
`.` represents the directory where you have saved `TBM.jar`. Here's a snippet of this editable text file:
Copy link
Member

Choose a reason for hiding this comment

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

I think the standardization for the md files is to not have line breaks unless the actual line is 2 lines, since word wrap can already do this kind of line wrapping for you

Comment on lines +253 to +254
**:information_source:** Tweaking this file should be done <strong><i>only</i></strong> if you're familiar with JSON
. If you're new to JSON, <a href="https://www.json.org/json-en.html">here's</a> a good place to learn more.
Copy link
Member

Choose a reason for hiding this comment

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

same for these lines, and many other lines in the file

docs/UserGuide.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 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
v1.4 automation moved this from Reviewer approved to Review in progress Oct 30, 2020
docs/UserGuide.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 Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
v1.4 automation moved this from Review in progress to Reviewer approved Oct 30, 2020
Copy link
Member

@LeeEnHao LeeEnHao left a comment

Choose a reason for hiding this comment

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

LGTM

@rtshkmr rtshkmr merged commit 93ff002 into AY2021S1-CS2103T-F11-4:master Oct 30, 2020
v1.4 automation moved this from Reviewer approved to Done Oct 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority.Medium Nice to have type.documentation Improvements or additions to documentation
Projects
No open projects
v1.4
Done
Development

Successfully merging this pull request may close these issues.

None yet

5 participants