Reworking Github facing documentation

[jonloucks]

Reworking Github facing documentation

Description

Reworking Github facing documentation

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Refactor (code improvement or restructuring without changing external behavior)
• Documentation update
• Chore (e.g., dependency updates, build tooling changes)

Checklist:

• My code follows the project's coding style guidelines.
• I have performed a self-review of my own code.
• I have commented my code, particularly in hard-to-understand areas.
• I have made corresponding changes to the documentation (if necessary).
• My changes generate no new warnings.
• I have added tests that prove my fix is effective or my feature works.
• New and existing unit tests pass locally with my changes.

Additional Notes