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

UG Guide Improvements #131

Closed
HanB1n opened this issue Oct 24, 2024 · 6 comments · Fixed by #170
Closed

UG Guide Improvements #131

HanB1n opened this issue Oct 24, 2024 · 6 comments · Fixed by #170
Assignees
Labels
priority.Medium Nice to have

Comments

@HanB1n
Copy link

HanB1n commented Oct 24, 2024

Update the JAR File Link.
Remove all symbols of AB3
Update the screenshot of Help function

@HanB1n HanB1n added the priority.Medium Nice to have label Oct 24, 2024
@HanB1n HanB1n self-assigned this Oct 24, 2024
@HanB1n
Copy link
Author

HanB1n commented Oct 24, 2024

Edit headers to be more presentable and segregated
Make the examples relevant to our use case, remove the Prison stuff

@tingxuanp
Copy link

tingxuanp commented Oct 24, 2024

Update command summary
Make language more user-centric
Could have more step by step guidance for using the addressbook initially
Even things like the meaning of tags need to be explicitly stated from the beginning

@HanB1n
Copy link
Author

HanB1n commented Oct 24, 2024

Fix hyperlinks

@tingxuanp
Copy link

tingxuanp commented Oct 24, 2024

Introduction: explicitly identify target users, assumptions, user-centric description of the product
give more examples for all commands

update screenshots

@tingxuanp
Copy link

Make layout more suitable for skimming and scanning, more spacing etc

could consider colour coding the features to make it easier to read?

@tingxuanp
Copy link

Update use cases examples for new commands

@HanB1n HanB1n linked a pull request Oct 29, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority.Medium Nice to have
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants