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 for strapi plugins repository - ReadMe.md #52

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

Documentation for strapi plugins repository - ReadMe.md #52

vishi24 opened this issue Mar 7, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation strapi-plugins plugins for strapi

Comments

@vishi24
Copy link
Collaborator

vishi24 commented Mar 7, 2024

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

  • 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

@vishi24 vishi24 added the documentation Improvements or additions to documentation label Mar 7, 2024
@vishi24 vishi24 changed the title Documentation for strapi plugins repository Documentation for strapi plugins repository - ReadMe.md Mar 11, 2024
@faizmagic faizmagic added the strapi-plugins plugins for strapi 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 strapi-plugins plugins for strapi
Projects
None yet
Development

No branches or pull requests

3 participants