Documentation

Public Documentation

Feature documentation should be done by the team that implemented the feature. Please also update the Introduction and Permissions pages if needed.

Any Pull Request (PR) that has changes to the functionality or User Interface (UI) needs to be labelled with docs: external and the Documentation part of the PR needs to be filled out. You do not have to write up the whole documentation here, just a couple of bullet points or screenshots to indicate what has been changed / how it should work.

Any updates to the public docs should be done in a PR in the mSupply_docs repository and will be merged on release cycle's PR merged date.

Example:

## 📃 Documentation
<!-- Note down any areas which require documentation updates -->

- [ ] New `issued` column in `Requisitions` indicates stock quantity already in shipments

Documentation Standards

1. Only screenshot the App Nav section when screenshotting gotos
2. Use a table when listing out columns with descriptions
3. Try not to get the App Nav in screenshots or have it collapsed so that screenshots don't have to be updated when App Nav is updated
4. note, tip, update, warning should be done in a div class

Internal Documentation

Any part of the code base that needs internal documentation needs to be labelled with docs: internal.

Once you have done the docs whether they be external or internal, please change the label from docs: external or docs: internal to doc: done