beckn / strapi-plugins

0 stars 1 forks source link

Documentation for strapi plugins repository - ReadMe.md #52

Open vishi24 opened 6 months ago

vishi24 commented 6 months ago

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.
  5. License: Please use the license file used here.
  6. Details about all the plugins and what is the use ?

Please follow the structure here

Goals

Expected Outcome

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

Acceptance Criteria

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