accessibility-insights-web icon indicating copy to clipboard operation
accessibility-insights-web copied to clipboard

need architectural docs to better understand this project

Open LUTLJS opened this issue 3 years ago • 2 comments

I have spoken to the early team member Sebastian Morales about providing any software engineering documentation like Requirement Specifications, User Interface Design, etc. This would help new contributors better understand how this project is implemented and make new contributions more easily.

LUTLJS avatar Aug 11 '22 01:08 LUTLJS

This issue has been marked as ready for team triage; we will triage it in our weekly review and update the issue. Thank you for contributing to Accessibility Insights!

ghost avatar Aug 11 '22 14:08 ghost

Thanks for the feature request, @LUTLJS, as we work on different features, we will look for opportunities to add architectural docs. Adding this to our backlog

ferBonnin avatar Sep 12 '22 21:09 ferBonnin

As part of the MV3 work we recently added this architecture doc, which seems to cover at least part of this request: https://github.com/microsoft/accessibility-insights-web/blob/main/docs/mv3-architecture.md

sfoslund avatar Oct 31 '22 16:10 sfoslund

Plan is to add future architecture documents to the repo, but we aren't going to try to do this retroactively.

DaveTryon avatar Jul 14 '23 18:07 DaveTryon