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

A-UserGuide: User Guide #54

Closed
ianyong opened this issue Sep 15, 2020 · 0 comments · Fixed by #58
Closed

A-UserGuide: User Guide #54

ianyong opened this issue Sep 15, 2020 · 0 comments · Fixed by #58
Assignees
@ianyong
Labels
cs2103t-requirement Required for CS2103T enhancement New feature or request
Milestone
Week 6

Comments

@ianyong
Copy link
Owner

ianyong commented Sep 15, 2020 •
edited
Loading

  • A-UserGuide: Add a User Guide

Add a User Guide to the project. Here is one simple way to do it.

  • Update the given docs\README.md. See this guide to GitHub flavored Markdown (GFMD).
  • Go to the settings page of your Duke fork and enable GitHub pages to publish from the docs folder (you can select a theme too).
  • Go to http://{your username}.github.io/{repo name}/ to view the user guide of your product. Note: it could take 5-10 minutes for GitHub to update the page.

Refer to https://nus-cs2103-ay2021s1.github.io/website/schedule/week6/project.html#a-userguide.
@ianyong ianyong added enhancement New feature or request cs2103t-requirement Required for CS2103T labels Sep 15, 2020
@ianyong ianyong added this to the Week 6 milestone Sep 15, 2020
@ianyong ianyong self-assigned this Sep 15, 2020
@ianyong ianyong mentioned this issue Sep 15, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ianyong ianyong

Labels
cs2103t-requirement Required for CS2103T enhancement New feature or request
Projects
None yet
Milestone
Week 6
Development

Successfully merging a pull request may close this issue.

Add user guide ianyong/ip
1 participant
@ianyong