Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Checkup of the documentation #90

Merged
merged 2 commits into from
Sep 4, 2023
Merged

Checkup of the documentation #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a942c99
Move assets to docs/assets
sebastienvermeille Sep 4, 2023
671f81e
Update links
sebastienvermeille Sep 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ jobs:
- name: Discord notification
env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
DISCORD_AVATAR: "/~https://github.com/sebastienvermeille/rika2mqtt/blob/master/assets/rika2mqtt.png"
uses: Ilshidur/action-discord@master
with:
args: '{{ EVENT_PAYLOAD.repository.full_name }} version {{ EVENT_PAYLOAD.release.name }} is out!'
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RIKA2MQTT

![logo](./assets/rika2mqtt-128x128.png)
![logo](./docs/assets/rika2mqtt-128x128.png)

RIKA2MQTT is a free and opensource bridge enabling end-users to connect their RIKA firenet stove to an MQTT server.
It goes both way so you can monitor and also take control of your stove directly via MQTT.
Expand Down
2 changes: 1 addition & 1 deletion docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "Rika2Mqtt",
"description": "Connect your RIKA stove to MQTT and gain control the way you want!",
"favicon": "/assets/rika2mqtt-128x128.png",
"favicon": "/assets/favicon.png",
"logo": "/assets/rika2mqtt-128x128.png",
"googleAnalytics": "G-5K9CY84T71",
"theme": "#36B9B9",
Expand Down
Binary file added docs/assets/favicon.ico
View file
Open in desktop
Binary file not shown.
Binary file added docs/assets/favicon.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
0 assets/rika2mqtt-128x128.png → docs/assets/rika2mqtt-128x128.png
View file
Open in desktop
File renamed without changes
0 assets/rika2mqtt-logo.png → docs/assets/rika2mqtt-logo.png
View file
Open in desktop
File renamed without changes
0 .doc/rika2mqtt.drawio → docs/assets/rika2mqtt.drawio
View file
Open in desktop
File renamed without changes.
0 .doc/rika2mqtt.drawio.png → docs/assets/rika2mqtt.drawio.png
View file
Open in desktop
File renamed without changes
0 assets/rika2mqtt.png → docs/assets/rika2mqtt.png
View file
Open in desktop
File renamed without changes
4 changes: 2 additions & 2 deletions docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RIKA2MQTT Documentation

<Image src="./../assets/rika2mqtt-128x128.png" rika2mqtt />
<Image src="/assets/rika2mqtt-128x128.png" rika2mqtt />

## What is it ?

Expand All @@ -13,4 +13,4 @@ You can even send commands to your stove via MQTT, let's drive your stove the wa

## Overview

<Image src="https://raw.githubusercontent.com/sebastienvermeille/rika2mqtt/master/.doc/rika2mqtt.drawio.png" alt="Communication flow diagram stove -> rika firenet ; rika2mqtt -> rika firenet ; rika2mqtt -> mqtt" />
<Image src="/assets/rika2mqtt.drawio.png" alt="Communication flow diagram stove -> rika firenet ; rika2mqtt -> rika firenet ; rika2mqtt -> mqtt" />