search

AY2223S2-CS2103T-T13-1 / tp

https://ay2223s2-cs2103t-t13-1.github.io/tp/
MIT License
0 stars 5 forks source link

Documentation Bugs #99

Closed Dangabit closed 1 year ago

Dangabit commented 1 year ago

Please collate all the documentation bugs you find here!

Those that are done, please indicate with a 👍

Dangabit commented 1 year ago

Bug: index.md badges for CI and CodeCov shows AB3's ones.

Change codecov badge image source to "https://codecov.io/gh/AY2223S2-CS2103T-T13-1/tp/branch/master/graph/badge.svg" and JavaCI to "https://github.com/AY2223S2-CS2103T-T13-1/tp/workflows/Java%20CI/badge.svg"

jmestxr commented 1 year ago

Our custom local fonts might not work on some PCs (idk the reason). I added some fallback fonts that JavaFX definitely supports.

Just in case, we should add a note in Quick Start section that the font in the GUI image shown may not correspond exactly to what you see on JavaFX application. However, it does not matter as it does not affect functionality of our app.

jmestxr commented 1 year ago

Under DG implementation section, the following diagrams are too small:

jmestxr commented 1 year ago

Under DG implementation section, the following diagrams which I feel are important are missing:

<---> denotes interaction

If we are up to it, we could also, for each implementation, add sequence diagrams that show high-level interactions between ui + logic + model.

Dangabit commented 1 year ago

Check through all documents and remove any resemblances of AB3. We can split the work for this.

Dangabit commented 1 year ago

Update any GUI screenshots of our app, for UG, DG (?), README ...

Jun-How commented 1 year ago

Update JavaDocs, probably need to split the work for this too.

jmestxr commented 1 year ago

DG: to update Use Cases.

For example, there is missing information such as in:

Screenshot 2023-04-02 at 11 17 16 PM

Should be: The given module code, credits or year-semester is missing or invalid.

jmestxr commented 1 year ago

DG: to update Use Cases.

For example, there is missing information such as in: Screenshot 2023-04-02 at 11 17 16 PM Should be: The given module code, credits or year-semester is missing or invalid.

Resolved

jmestxr commented 1 year ago

Update any GUI screenshots of our app, for UG, DG (?), README ...

Resolved