-
-
Notifications
You must be signed in to change notification settings - Fork 314
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Centralize and update test documentation - Part 1 Explanation section #4686
Conversation
Thanks @Ndacyayisenga-droid - can you also create a pages dir inside of docs to mimic what is currently in smlambert.github.io ? (with these 4 pages inside of it). That layout and all of the extra files inside of https://github.com/smlambert/smlambert.github.io/tree/main/docs are used to serve up the documentation (as seen at https://smlambert.github.io/). Once we have that structure in place, we can start adding more pages, and linking them off of the 4 main categories as appropriate. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hi @Ndacyayisenga-droid - thanks for pulling this together.
These 4 pages that you are adding will contain lists and denote the 4 types of documents we will have in the project. Under the "aqa-explanation" category which should be answering "why", I think we will have 3 separate docs linked from the aqa-explanation page (mentioned in #1558 (comment))
- AQAvit manifesto (which can stay in its own document as it is now, Manifesto.md, but get moved from doc dir into into the docs/pages dir)
- Scope of AQAvit (which I can write and can be in its own doc /docs/pages/Scope.md)
- Why the '3 layer cake' architecture (which can be its own doc /docs/pages/LayeredDesign.md and feature a diagram of the 3 functional layers of AQAvit and what purpose each layer serves)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here is my first round of reviews @Ndacyayisenga-droid
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Co-authored-by: Shelley Lambert <slambert@gmail.com>
hi @Ndacyayisenga-droid - let's move this one out of draft |
Co-authored-by: Hendrik Ebbers <hendrik.ebbers@web.de>
Co-authored-by: Hendrik Ebbers <hendrik.ebbers@web.de>
Co-authored-by: Hendrik Ebbers <hendrik.ebbers@web.de>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of extra comments to address prior to merging.
Co-authored-by: Shelley Lambert <slambert@gmail.com>
Fixes part of #1558