Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Survey current progress and gaps in documentation - Backend #562

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Ashdeore
Copy link

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

Document for survey current progress and gaps in documentation- Backend
Copy link

@Shounaks Shounaks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

@s223552468 s223552468 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants