search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Incorrect links in DG #876

Open nus-se-script opened 5 days ago

nus-se-script commented 5 days ago

image.png

image.png

image.png

Many links in the DG point, such as the link to each component's source code, link to code in the original AB3 app.

This might confuse future developers.

[original: nus-cs2103-AY2425S1/pe-interim#1232] [original labels: severity.Low type.DocumentationBug]

publicmain commented 4 days ago

Team's Response

Thank you for your testing, Firstly, since AB3 was the original template for the project, any references or links to code from the original AB3 in the documentation do not necessarily constitute an error or major issue. While these links may point to parts of the old project, developers familiar with the project's history would typically understand this, and it would not lead to significant confusion.

Secondly, having links that reference the original template can actually be beneficial, as they provide context for the project's evolution and architecture. For new developers, this context can serve as a useful reference point to understand the underlying structure and progression of the codebase.

Finally, addressing this issue would simply require minor updates to the documentation and poses minimal impact on the functionality or usability for developers. Therefore, the overall severity of the issue is verylow and does not justify a higher priority rating.

Duplicate status (if any):

--