search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Incorrect hyperlinks to SE-EDU repo in DG #2077

Open nus-se-script opened 5 days ago

nus-se-script commented 5 days ago

In the DG, there are several places which still links to the AB3 code in the SE-EDU repo.

For example, in the UI Component section, UI.java file correctly links to the team's repo, but MainWindow and MainWindow.fxml still link back to AB3.

Screenshot 2024-11-15 at 5.13.06 PM.png

This may be confusing for new developers who are onboarding to the codebase as the AB3 code in the SE-EDU repo is different from what is being described in the DG (in fact, different from what is drawn in the UML diagram directly above)

I put this as low severity because I think it would not be too difficult for a developer to realize the error, though it would cause some minor inconveniences during the onboarding process.

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

sumomomomomo commented 4 days ago

Team's Response

No details provided by team.

Duplicate status (if any):

--