How to update

Manually

Send pull requests via GitHub as per usual. If you see this and do not have access, then contact the QA team to request alterations.

Auto generation

This can be updated by running:

cd ~/git/drains/packages/@kt-devel-scripts/internal-doc-manager
pnpm run generate

Standard directories per feature

For each area of interest, you should see the following

    README.md
    proposals/
        - initial plans/specs before they grow (should be `yyyy-mm-dd-....` formatted)
        - could include longer term planning for what is not yet in scope
    use_cases/ - Populated at start of project, updated as needed - helps set requirements
        - why do people want this / how do they use it / what needs QA testing
        - AS A xxx I WANT yyy SO THAT zzz
    acceptance_criteria/ - populated by QA from use_cases/experience!
        - what should happen / QA scenarios
        - GIVEN / WHEN / THEN
    docs_configuration/
        - what can be configured - maybe generated from TypeScript Config types + a README?
    doc_technical/
        - technical reference documentations
    docs_user/
        - Stuff that might be made public at some point