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.

Sign up for GitHub

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

Jump to bottom

Updating devguide and userguide #129

Merged
merged 7 commits into from
Oct 28, 2020
Merged

Updating devguide and userguide #129

merged 7 commits into from
Oct 28, 2020

Conversation

pennhanlee
Copy link
Collaborator

closes #118

Introduction

  • The introduction may seem informal. Its purpose is to create a friendly tone to readers
  • Separated the download and starting of the application for clarity
  • Added a tour to help users familiarise with the purpose of each sections
    • the summary sidebar that leyang created
    • the window for listing of books
    • the area to input text

Features

  • Added "so that" explanation for the features.
  • Changed up the display of example commands to help make
    each command explanation a little more consistent

Added quite a bit of You language throughout the UG. DG edits still in progress.

@pennhanlee pennhanlee added the type.Documentation Changes to the documentation of the project label Oct 28, 2020
@pennhanlee pennhanlee added this to the v1.3 milestone Oct 28, 2020
@pennhanlee pennhanlee self-assigned this Oct 28, 2020
@pennhanlee pennhanlee changed the title Updating devguide Updating devguide and userguide Oct 28, 2020
angrybunny123
angrybunny123 reviewed Oct 28, 2020
View reviewed changes
Copy link
Collaborator

@angrybunny123 angrybunny123 left a comment

Choose a reason for hiding this comment

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

Really like the introduction, LGTM!

TanLeYang
TanLeYang approved these changes Oct 28, 2020
View reviewed changes
Copy link
Collaborator

@TanLeYang TanLeYang left a comment

Choose a reason for hiding this comment

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

Nice! LGTM

@TanLeYang TanLeYang merged commit 2ecdf44 into AY2021S1-CS2103T-F13-2:master Oct 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@angrybunny123 angrybunny123 angrybunny123 left review comments

@TanLeYang TanLeYang TanLeYang approved these changes

@pangpuncake pangpuncake Awaiting requested review from pangpuncake

@mgiang2015 mgiang2015 Awaiting requested review from mgiang2015

Assignees

@pennhanlee pennhanlee

Labels
type.Documentation Changes to the documentation of the project
Projects
None yet
Milestone
v1.3
Development

Successfully merging this pull request may close these issues.

Add Introduction to DG and UG
3 participants
@pennhanlee @TanLeYang @angrybunny123