adr-005-git-docs.md

2024-01-01 | ๐Ÿ“‘ 79 words | โฑ 1 mins | ๐Ÿงพ History | โœ NHS Notify | ๐Ÿ”‘ NHS Notify

๐Ÿšง This page has less that 200 words. So it looks like this page is still under construction.

Documentation stored within repo

Known Issues / Todo

  • โ›… This page is draft and is subject to rapid change, and may not be fully accurate or complete

ย  ย 
Date 2024-05-22
Status Decided
Deciders Engineering
Significance Ross Buggins

Decision

  • /docs folder to hold relevant technical documentation for the code in that repository
  • Utilise this instead of internal confluence repositories
  • Markdown as standard
  • GitHub pages for build and deploy
  • Just the docs as the standard theme