Skip to content

Commit bbeb0d9

Browse files
authored
chore: Documentation cleanup and updates (#725)
Some lower level documentation cleanup: - Convert existing v1 API command documentation to markdwon - Remove the remaining old stale documentation that is duplicative of other sources - Rewrite roborock/devices/README.md as simpler higher level documentation focused on library usage - Copy the existing roborock/devices/README.md which is internal focused into docs/ This establishes docs/ as the internal facing documentation library only, for unsupported features or internal library details.
1 parent 0c4b90a commit bbeb0d9

File tree

15 files changed

+2465
-3029
lines changed

15 files changed

+2465
-3029
lines changed

docs/DEVICES.md

Lines changed: 669 additions & 0 deletions
Large diffs are not rendered by default.

docs/Makefile

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Roborock Documentation
2+
3+
This directory contains lower level documentation for developers interested in:
4+
5+
- Details about the lower level transport protocols used by the library
6+
- Undocumented or unsupported device commands or RPCs
7+
- The internal design of components of the library
8+
9+
For details about using the library see the higher level documentation at https://python-roborock.github.io/python-roborock/

0 commit comments

Comments
 (0)