Skip to content

Contribute to docs

Introduction

You can contribute to the contents on this site as follows:

  • Create a fork
  • Edit in your fork (Commit -> workflow -> new pages)
  • Create pull request
  • See also Good to know

Fork

Edit using github

  • Clone your fork (https://github.com/yourfork/WLED-Docs.git)
  • Create a branch in your fork if you want to create a pull request for changes in that branch only
  • Make edits in your fork / branch (https://github.com/yourfork/WLED-Docs/)
  • Commit

Edit in website

Go to https://yourfork.github.io/WLED-Docs or https://mm.kno.wled.ge/moonmodules/contribute-docs/ if you have contributor rights

  • Navigate to the page you want to edit
  • Press edit icon

  • Edit the file

  • Images can be added by dragging them to the page (see earlier added images and videos for the syntax to be used, use width="xxx" to adjust the size)

  • Commit (see workflow after commit)

Workflow after commit

If a commit is done a workflow will be started to create the pages.

Progress can be seen in https://github.com/yourfork/WLED-Docs/actions

image

This will take some time (about 30s)

After the workflow is completed new version of your kno.wled.ge can be found here:

https://yourfork.github.io/WLED-Docs

Create pull request

  • Create pull request from https://github.com/yourfork/WLED-Docs/ to https://github.com/MoonModules/WLED-Docs/
  • Pull from a branch if you only want to pull the changes in that branch

Fork specific info

WLED SR

kno.wled.ge not supported help is in maintenance mode and can be found here: https://github.com/Atuline/WLED/wiki

WLED AC

Above can also be done on https://github.com/Aircoookie/WLED-Docs