MagicMirrorOrg / MagicMirrorOrg/MagicMirror-3rd-Party-Modules

[docs] Move some guides to the docs repository

Open
#59 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
48
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Like discussed in PR #57 we may transfer some parts of the guides to the official docs repository.

As there are different views on best practices, we may have to take a step-by-step approach.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the discussion in PR #57, then compare the guides directory with the official MagicMirror-Documentation repository. Identify a specific subset suitable for transfer and confirm the preferred approach before editing. Done means the agreed guides are moved without leaving unclear ownership between the two repositories.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.