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

ReadME review and update for generic-client layer #35

Open
2 tasks
vishi24 opened this issue Mar 7, 2024 · 0 comments
Open
2 tasks

ReadME review and update for generic-client layer #35

vishi24 opened this issue Mar 7, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation generic-client-layer generic client layer related

Comments

@vishi24
Copy link
Collaborator

vishi24 commented Mar 7, 2024

Description

Generic client layer repository has some documentation about the project and source, but it does not seem to be in line with the actual source code, it needs review and update. Also, it has some of the sections missing. It must should contain the below sections.

  1. Project Title and Description:Clearly state the project name and provide a concise description of its purpose and functionalities.
  2. Table of Contents (Optional):Include a table of contents for longer READMEs, especially if you have multiple sections.
  3. Installation Instructions:Detail the steps required to set up and run the project, including any dependencies and system requirements.
  4. Usage Instructions: Explain where is this required and how to use the project, including basic commands, functionalities, and relevant examples.

Use this format to update the redaMe documentation.

Goals

  • Clear, correct, and detailed documentation about the repository.

Expected Outcome

User should be able to understand the functionality/usage and how-to of the project by reading the documentation.

Acceptance Criteria

  • Correctly updated documentation for generic-client layer repository.

Implementation Details

NA

Mockups / Wireframes

NA


[Please note that the below section of the ticket has to be in the format as mentioned as it is key to enabling proper listing of the project. Please only choose the options mentioned under the headings wherever applicable.]

Product Name

generic-client-layer

Project Name

generic-client-layer

Tech Skills Needed:

generic-client-layer knowledge

Complexity

Low

Category

documentation

Sub Category

Documentation

@vishi24 vishi24 added the documentation Improvements or additions to documentation label Mar 7, 2024
@vishi24 vishi24 changed the title Documentation review for generic-client layer Documentation review and update for generic-client layer Mar 8, 2024
@vishi24 vishi24 changed the title Documentation review and update for generic-client layer ReadME review and update for generic-client layer Mar 13, 2024
@faizmagic faizmagic added the generic-client-layer generic client layer related label Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation generic-client-layer generic client layer related
Projects
None yet
Development

No branches or pull requests

3 participants