Skip to content
This repository has been archived by the owner on Dec 27, 2023. It is now read-only.

[Week 11] 2: Update user docs #127

Closed
Cloud7050 opened this issue Oct 29, 2023 · 8 comments
Closed

[Week 11] 2: Update user docs #127

Cloud7050 opened this issue Oct 29, 2023 · 8 comments
Assignees
@Cloud7050 @bwangpj @rayshawntan @mamayuan
Labels
critical [Priority] Mission-critical; must be done Documentation [Category] MEDIUM [Workload] user guide Documentation sublabel
Milestone
v1.3b

Comments

@Cloud7050
Copy link

https://nus-cs2103-ay2324s1.github.io/website/schedule/week11/project.html#2-update-user-docs

Updated draft of the UG & landing page.
@Cloud7050 Cloud7050 added critical [Priority] Mission-critical; must be done MEDIUM [Workload] labels Oct 29, 2023
@Cloud7050 Cloud7050 added this to the v1.3b milestone Oct 29, 2023
@Cloud7050 Cloud7050 mentioned this issue Oct 29, 2023
Closed
@Cloud7050 Cloud7050 added Documentation [Category] user guide Documentation sublabel labels Oct 29, 2023
@Cloud7050 Cloud7050 mentioned this issue Oct 29, 2023
Closed
@bwangpj bwangpj mentioned this issue Oct 30, 2023
Merged
@Cloud7050
Copy link
Author

The landing page mentions and links to a UG "quick start" section which we no longer have. This will need to be updated depending on what we do with the UG.

We could merge in some of the contents of the original AB3 UG to flesh out ours, since our original draft made without knowing much about the codebase / existing docs replaced the entire UG.

@Cloud7050
Copy link
Author

Our UG table of contents is currently broken.

@Cloud7050
Copy link
Author

I'm planning to do a pass over the UG, command help text, and sample data shortly. To minimise duplication of work (ie editing the same part differently at the same time) and merge conflicts, let's keep in communication.

@Cloud7050
Copy link
Author

See also:

Product description in course PR: nus-cs2103-AY2324S1#63

@Cloud7050 Cloud7050 mentioned this issue Nov 1, 2023
Merged
1 task
@Cloud7050
Copy link
Author

Just for tracking:

@rayshawntan the exact format of ALTERNATE_CONTACT could be added to the UG. AlternateContact Javadocs could be updated (I saw mentions of email)

@bwangpj docs for filter are pending addition to UG

@Cloud7050
Copy link
Author

We could probably do with more images in the UG, where useful. There are currently none save for our Ui.png.

@Cloud7050
Copy link
Author

As part of this issue, our Ui.png needs updating to be a real cropped screenshot.

@bwangpj bwangpj mentioned this issue Nov 2, 2023
Merged
@Cloud7050
Copy link
Author

Cloud7050 commented Nov 2, 2023 •
edited
Loading

@Cloud7050 Cloud7050 mentioned this issue Nov 2, 2023
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@Cloud7050 Cloud7050

@bwangpj bwangpj

@rayshawntan rayshawntan

@mamayuan mamayuan

Labels
critical [Priority] Mission-critical; must be done Documentation [Category] MEDIUM [Workload] user guide Documentation sublabel
Projects
None yet
Milestone
v1.3b
Development

No branches or pull requests
4 participants
@Cloud7050 @bwangpj @rayshawntan @mamayuan