Skip to content

Latest commit

聽

History

History
51 lines (29 loc) 路 2.25 KB

File metadata and controls

51 lines (29 loc) 路 2.25 KB

馃嚞馃嚙 English | 馃嚝馃嚪 Fran莽ais

Jeedom documentation

The website gathering the Jeedom documentation is available at the following address: https://doc.jeedom.com/home/en_US/.

Contribute to documentations

Important

Please read the Contribute to documentations page before any intervention.

General documentation

The general Jeedom documentation pages are directly accessible on this repository. Each section has its own folder (compatibility, contribute, dev, etc.), contributions must only be submitted in the fr_FR folder of the relevant section.

Caution

Contributions can be made to any folder except core, plugins and plugins_contributor. These pages are generated from the Jeedom core and plugin repositories, any changes made to these folders would be overwritten by the next day. The PHPDoc documentation is also automatically generated and must not be modified manually either.

Core documentation

Documentation relative to the Jeedom core (user and configuration manuals) can be found in the docs/fr_FR folder of the core repository: https://github.com/jeedom/core/tree/develop/docs/fr_FR. The develop branch should be preferred for contributions.

Plugins documentation

As with the Jeedom core, the documentation for official plugins is automatically generated from the docs/fr_FR folder of the relevant plugin repository.

Contribute to development

Important

Please read the Contribute to the core and plugins page before any intervention.

Core

Like the documentation, the Jeedom core is open source and open to contributions. The full code is available at this address: https://github.com/jeedom/core/tree/develop.

Unless otherwise indicated, modifications must imperatively be submitted on the develop branch.

Plugins

It is also possible to contribute to plugins whose repositories are public. In most cases, modifications must be submitted on the beta branch.