bengreenier / bengreenier/overlayed2

Feature Request: Developer-centric guide to creating an overlay

Open
#3 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement help wanted
Dominant language
TypeScript
Stars
8
Forks
0
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**

As a developer who isn't a core maintainer of Overlayed, I'd like to be able to follow along with a quick guide to creating an Overlay, using my language (within reason - ie: `typescript` and `javascript`) and toolchain of choice.

**Describe the solution you'd like**

A written document outlining the steps to creating an overlay (what will likely be called `plugins` by the core team) with variations for different approaches. Referencing the built-in plugins would be valuable as well.

Contributor guide

Open the contributing guide

Research direction

Start by reading the repository's existing built-in plugins and the surrounding overlay implementation to identify the steps and supported approaches. The work is complete when a written developer guide explains how to create an overlay, includes TypeScript and JavaScript variations where practical, and references the built-in plugins.

Written by the indexing model from the issue text.

Assessment

Tech stack
electron, javascript, react, typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.