Skip to content

Commit

Permalink
Started new introduction.
Browse files Browse the repository at this point in the history
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
  • Loading branch information
Confectrician committed Jun 15, 2018
1 parent dc95657 commit 00a18ad
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,27 @@ This repository contains the documentation for openHAB.

The result is available at [http://docs.openhab.org/](http://docs.openhab.org/) [Deprecated] and [https://www.openhab.org/docs/](https://www.openhab.org/docs/)

## How it works

In this repo you can find and improve all *general* documentation contents.
In fact that is everything you can see in the `master` branch.
There are also other *read-only* branches, which hold external content like the *add-ons* and *concepts* documentation.
We will read about them later.

### So i can't improve a binding article here?

Correct, this is done in the corresponding addon repository.
You may want to know how to find the right file in all of those repos?
Thats fairly easy.
Just visit the page you want to improve in the docs directly.
You will find the following paragraph at the bottom, which will point you directly to the file you want to improve.

![Contribution link to a specific page](.images/contribution_link.png)

When your improvement has been made and merged, we will get the updated article automatically through our build mechanism.
This happens mostly once a day.
Afterwards your change is included in the next homepage build.

## Contributing to the Documentation

The documentation is a community effort, so everyone is welcome to suggest changes, add new sections and fix bugs.
Expand Down
Binary file added images/contribution_link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 00a18ad

Please sign in to comment.