search

imanamirshah / pe

0 stars 0 forks source link

No clear structure for Developer Guide, looks incomplete #19

Open imanamirshah opened 7 months ago

imanamirshah commented 7 months ago

image.png

Missing table of content - may look minor but it shows a much larger issue of the lack of structure in the developer guide. I am unable to clearly locate the design portion and the implementation portion as they are all mixed up. Hence, the implementation portion looks lacking, only showing some of the features and clearly lacking in showing the implementation of all other features available in the application. There are no diagrams to describe the overall architecture of the app so I am unable to really understand how the components work with one another.

Overall, the developer guide looks incomplete. There seems to be many lacking sections and diagrams. And the diagrams and sections described in it looks to be randomly picked out from all the available components and commands. Hence, it does not give a clear idea of how the app works, thus, the high severity.

soc-pe-bot commented 7 months ago

Your response not required for this bug as the team has accepted the bug as it is.