September Relay 2024 observations about the docs

[RichardBruskiewich]

Note: this is a verbatim copy of the Relay agenda minutes notes. Some of these issues may have been resolved or may now be obsolete after the Relay (need to review them on a case-by-case basis)

Observations about the help docs:

• UI docs unfinished: https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/architecture/ui/
• Should the UI in docs also cover the developer UI (https://arax.transltr.io/)?
• “Teams” is incomplete: https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/teams/
• FAQ’s are only partially populated: https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/faq/
• Tutorials only partially populated: https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/development-guide/tutorials/
• CI section not populated: https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/deployment-guide/ci/
• Deployment not populated: https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/deployment-guide/deployment/
• Should we update this glossary and put it somewhere more permanent? Glossary of Terms, Abbreviations, Acronyms - Translator Slim
• Developer Cookbook: https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/development-guide/cookbook/ - should this be linked from somewhere?
• Larry asked, “Will the Table Of Contents of the Developer Cookbook have hyperlinks to the contents?”

[nlharris]

I recommend turning this into actionable tasks (which can have checkboxes to check them off). Perhaps that's your intent and this is just a starting point.