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 Images and change formatting of the User Guide #309

Merged

Conversation

Respirayson
Copy link

No description provided.

Copy link

codecov bot commented Nov 13, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@Respirayson Respirayson added this to the v1.4 milestone Nov 13, 2023
This was linked to issues Nov 13, 2023
Copy link

@raydenlim raydenlim left a comment

Choose a reason for hiding this comment

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

Other than a few nits, LGTM!

For the screenshots, is there a sequence to it? as some addresses 2nd index as Bernice, others Charlotte.
Might want to add a disclaimer that the examples are sequential.

Choose a reason for hiding this comment

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

hmm this comment goes to all images ah.
Should we photoshop and make the strings wrap text? or temporatily make it wrap text in the output? so that users can see the full result display.

Copy link
Author

Choose a reason for hiding this comment

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

Hm I basically deleted my data file then started screenshotting and doing the commands in order. But I not sure how we gonna say that its sequential though

<br>

#### 👀Viewing Help : `help`
#### Clearing all Entries : `clear`

Choose a reason for hiding this comment

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

good catch on this!

> **Input:** `clear` Deletes all students in F.A.K.E.J.A.R.V.I.S.
>
> **Output:**
>`Address book has been cleared!`

Choose a reason for hiding this comment

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

Just occurred to me, should we change Address Book to F.A.K.E.J.A.R.V.I.S here?
i.e update UG and code. Seems like a bug sia.

Copy link
Author

Choose a reason for hiding this comment

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

I'm not sure whether we can for this though. I think its fine?

Copy link

@ldinghan ldinghan left a comment

Choose a reason for hiding this comment

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

Other than the part with deletecomment having highlighted output, LGTM. Thanks for taking all these screenshots!

Choose a reason for hiding this comment

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

Not sure why the text here is highlighted

@Respirayson Respirayson merged commit e6b972d into AY2324S1-CS2103T-T15-1:master Nov 13, 2023
5 checks passed
@Respirayson Respirayson changed the title Add Images to the User Guide Add Images and change formatting of the User Guide Nov 13, 2023
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.

UG: Update Screenshots UG: Add more screenshots
3 participants