Contribute to the documentation

Jeedom documentation is centralized on this site through several mechanisms. Like the Jeedom core, The documentation is available on GitHub and is open source (MIT license).

This can be divided into three main categories:

INFORMATION

If you want to review a large number of files, it’s best to do so in stages (by section, for example) rather than submitting many changes all at once.

Prerequisites

To contribute to the documentation, there are a few prerequisites you should be aware of and take into account:

INFORMATION

If you’re not comfortable editing the documentation files directly, you can also contribute by creating a topic on the forum with the tag documentation-jeedom.

General Documentation

The general documentation pages cover all sections except those related to Manuals (Jeedom core) and Plugins. The files are available at the documentation repository.

Each page of the documentation site corresponds to a file Markdown (*.md) on GitHub, for example:

IMPORTANT

Since the core and plugin documentation is generated from their own repositories, no contributions can be accepted in those folders core, plugins and plugins_contributor (see following paragraphs). The documentation PHPDoc is also generated automatically and therefore does not need to be modified manually either.

Jeedom Core Documentation

The Jeedom core documentation consists of the User Manual and Configuration Manual sections, which can be accessed by clicking the ❔ button in the upper-right corner of the Jeedom interface. The files are located at the core repository, in the directory docs/fr_FR.

Each page of the manual corresponds to a file Markdown (*.md) on GitHub, for example:

IMPORTANT

Contributions must be submitted to the branch develop at its core.

Plugin Documentation

The plugin documentation is organized into the sections Official Plugins and Third-Party Plugins. As their names suggest, official plugins are developed by the Jeedom team, while third-party plugins are created by external, independent developers.

Third-party plugins generate their own documentation and changelog pages; the Jeedom documentation site lists these pages and provides direct links to them.

The documentation for official plugins is retrieved directly from their GitHub repositories.

INFORMATION

Some plugin repositories are not publicly accessible. In that case, you can still contribute by creating a thread on the forum with the tag documentation-jeedom and the plugin’s.

As with the core, each documentation page for an official plugin corresponds to a file Markdown (*.md) on GitHub. Let’s take the ZwaveJS plugin as an example:

IMPORTANT

Contributions must be submitted to the branch beta plugins in the vast majority of cases.

Nous utilisons des cookies pour vous garantir la meilleure expérience sur notre site web. Si vous continuez à utiliser ce site, nous supposerons que vous en êtes satisfait.