Documentation Survey current progress and gaps in documentation - Backend

[Ashdeore]

Document for survey current progress and gaps in documentation- Backend

Any italic text should be deleted from the final Pull Request text, including this line

Description

In this file I have gone through all the Backend files and API's and done a quick survey on current progress and gaps in documentation.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

• 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)
• Documentation (update or new)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can
reproduce. Please also list any relevant details for your test configuration

Testing Checklist:

• Tested in latest Chrome
• Tested in latest Safari
• Tested in latest Firefox

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have requested a review from ... on the Pull Request

[Shounaks]

Peer Review:
This document goes through backend-codebase and documents APIs which have hitherto no been documented. @Ashdeore thanks for a comprehensive list. We need to focus some of our efforts of Development team to improve documentation in these areas.

[s223552468]

Approved
I have reviewed the changes, and everything appears to be accurate and complete. The file provides a thorough survey of backend files and APIs, highlighting progress and gaps in documentation.

[satikaj]

To be revisited next trimester to address the following:

• Outdated and incorrect documentation
• Gaps / areas lacking in documentation

Also, all docs that go in doubtfire-astro must be strictly validated and must be only what end-users need.