Resolve "Add a RefCounter subsystem README"
MERGE REQUEST
Overview
This MR aims to bring the RefCounter subsystem README to the level required by the Engineering Guidelines.
The Engineering Guidelines on subsystem READMEs:
Every subsystem needs to be documented in the module README. The overall intention and architecture of the subsystem should be documented. Also required to be documented are all interactions with other subsystems that use the ‘call’ methods. Both outgoing and incoming interactions need to be documented.
NOTE: I'm not exactly sure what's the expected level of detail when describing the inbound/outbound complexities. I'm very much open to suggestions/explanations.
Example: The Worker subsystem.
Example for Visual Changes
Checklist
Review and complete the checklist to ensure that the MR is complete before assigned to an approver.~~
[ ] All new methods or updated methods have clear docstrings[ ] Testing added or updated for new methods[ ] Any new packages are added to Makefile and .gitlab-ci.yml[ ] API documentation updated for API updates[ ] Module README.md updated for changes to workflow[ ] Issue added to Sia-UI repo for new supporting features[ ] Changelog File Created
Issues Closed
Closes #4150 (closed)