search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

DG API Storage link is wrong. #2600

Open nus-pe-bot opened 4 months ago

nus-pe-bot commented 4 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

Clicking on the storage link brings me to original AB3 code base.

image.png

[original: nus-cs2103-AY2324S2/pe-interim#2152] [original labels: type.DocumentationBug severity.High]

nigel27022001 commented 4 months ago

Team's Response

It should not be high as hyperlinks do not make the Developer guide unusable, but rather inconvenienced as they would have to click on the source code link at the top of the developer guide webpage, meaning that there is a way around the problem. All in all, we feel that it doesnt affect the readability of the DG, rather the convenience of being able to access the source code at a touch of a hyperlink. The problem could be solved by just removing the feature of having hyperlinks to source code in general.

Duplicate status (if any):

--