YetAnotherClown/planck

ECR Setup Guide

Open

#11 opened on Feb 26, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Luau (16 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (56 stars)
PR merge metrics
 (PR metrics pending)

Description

We should have a setup guide for ECR identical to Jecs or Matter's setup guide in the current documentation. Matter's setup guide may contain information more relevant to ECR, as the Jecs setup guide has examples only relevant to Jecs. It should include setup for an Ebba Plugin as well, which currently does not exist in Planck yet, so that must be finished first.

Contributor guide

Research direction
Examine the existing Jecs and Matter setup guides in the Planck documentation to understand formatting and content. Additionally, verify that the Ebba Plugin setup is complete before starting the ECR guide.
Tech stack
lua
Domain
backenddocumentation
Issue type
Documentation
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ECS conceptsPlanck documentation structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70