idyll-lang/idyll

Add docs page for plugins

Open

#526 opened on Jun 7, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (1,977 stars) (97 forks)batch import
Docshelp wanted

Description

Is your feature request related to a problem? Please describe. Idyll has a rich plugin infrastructure, but it isn't well-surfaced in the documentation. Currently you would have to know to navigate to the plugins repo in order to learn about them.

Describe the solution you'd like A new page, under the overview section that lists the plugins and provides link to resources on how to make your own.

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Idyll documentation structureBasic knowledge of Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Examine the existing documentation structure in the Idyll repository's docs folder. Identify where to add a new page under the overview section. Look at the idyll plugins repository for existing plugins and their descriptions. Create a new Markdown file listing plugins with links and a section on how to create custom plugins.