Skip to content

Commit

Permalink
docs: Misc
Browse files Browse the repository at this point in the history
  • Loading branch information
Hypfer committed Nov 28, 2023
1 parent 0d5a7df commit 71d0f43
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 23 deletions.
18 changes: 3 additions & 15 deletions docs/_pages/general/newcomer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ The [getting started guide](https://valetudo.cloud/pages/general/getting-started

## Where can I get support?

If you're looking for answers/supported, the first place to look are the docs.
If you're looking for answers/support, the first place to look are the docs.

Furthermore, you can also check the [Telegram Group](https://t.me/+zXeyaM-gt71jZGEy).
Telegram features a very powerful full-text search so make sure to use that before asking.
Expand All @@ -122,18 +122,6 @@ In general and especially if you're new to open source, It's strongly recommende

## How can I contribute to Valetudo?

### As a regular user
Generally speaking, the best way to contribute to Valetudo is to support other Valetudo users.

You don't need to be a developer to contribute to Valetudo, because the best way to support the project is to support other Valetudo users of which there are quite a few.

Just stick around in the Telegram Group, the IRC and/or the GitHub Discussions :)

### As a developer

If you're a developer, the usual stuff applies.
They may be Issues tagged with "Good First Issue" which should be the right place to start.

If you intend to open a PR, please make sure to make yourself familiar with the [PR Template](https://raw.githubusercontent.com/Hypfer/Valetudo/master/.github/PULL_REQUEST_TEMPLATE.md).

If you intend to add a new feature, you should expect the discussion thread to be open at least a few weeks until you can start working on that.
Please note that no response doesn't mean yes. PRs not following these rules will be closed without further discussion
For anything beyond that, make sure to familiarize yourself with the [CONTRIBUTING.md](https://github.com/Hypfer/Valetudo/blob/master/CONTRIBUTING.md)
19 changes: 11 additions & 8 deletions docs/_pages/general/supported-robots.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,22 @@ order: 9

# Supported Robots

At the time of writing, (2022-11-20), Valetudo supports more than 20 different Robots.<br/>
If you're interested in hardware specifics, teardowns and more, check out Dennis Giese's [Vacuum Robot Overview](https://dontvacuum.me/robotinfo/).
At the time of writing, (2023-11-28), Valetudo supports more than 30 different Robots.<br/>
If you're interested in hardware specifics, teardowns and more, check out Dennis Giese's [Vacuum Robot Overview](https://robotinfo.dev/).

Please note that Vacuum Robots tend to look very similar to each other. Before you make any assumptions, please consider
asking in the Telegram Group or on the IRC. You can only brick your robot once.
Please note that this list is exhaustive. These are the supported robots.<br/>
Robots not on this list are not supported by Valetudo. If your robot is not on this list, it is not supported.

Unless noted otherwise, you can assume that these robots were tested by us.<br/>
**HOWEVER** if noted otherwise, please be aware that the experience can be bad and not representative for Valetudo.<br/>
There may be no one that can help you if something goes wrong. You might even end up with a permanently bricked robot.
Unless noted otherwise, these robots were all tested by me personally to ensure that:
- They work properly with Valetudo
- The way to get them to work with Valetudo is well documented
- I have an Idea how the thing works, how rooting works and what to do when things don't work

Being _supported_ means meeting these criteria. Only by fulfilling these conditions can a robot be deemed supported.
<br/>

Hint:<br/>
You can use Ctrl + F to look for your model of robot.<br/>
**Please** make sure to read and understand the information written there.

## Table of Contents

Expand Down

0 comments on commit 71d0f43

Please sign in to comment.