beckn / beckn/strapi-plugins

Documentation for strapi plugins repository - ReadMe.md

Open
#52 0 comments 0 reactions 1 assignee Claimed by @em-abee View on GitHub
documentation strapi-plugins
Dominant language
TypeScript
Stars
0
Forks
5
PR merge metrics
No merged PRs in 30d

Description

## Description

Strapi-plugins repository is missing documentation. Please create proper documentation for the repository that includes the below details.

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 if we have multiple sections.
3. Installation Instructions: Detail the steps required to set up and run the project, including any dependencies and system requirements. Add screenshots/videos of installation and usage.
4. Usage Instructions: Explain how to use the project, including basic commands, functionalities, and relevant examples.
6. License: Please use the license file used [here]( https://github.com/beckn/beckn-utilities/blob/main/LICENSE.md).
7. Details about all the plugins and what is the use ?

Please follow the structure [here](https://fide-official.atlassian.net/wiki/spaces/BPM1/pages/45908109/Document+Structure+for+README)

## Goals

- [ ] Repository must have a proper documentation
- [ ] .

## Expected Outcome

A readme file (documentation) that has all the relevant details provided in the description section.

## Acceptance Criteria

- [ ] Properly structure readme file with all the required details.

## 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

strapi-plugins

### Project Name

strapi-plugins

### Tech Skills Needed:

strapi-plugin repo knowledge
Documentation

### Complexity

Low

### Category

Documentation

### Sub Category

Documentation

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.