Bug 454602 - missing documentation for bluedevil
Summary: missing documentation for bluedevil
Status: RESOLVED FIXED
Alias: None
Product: docs.kde.org
Classification: Websites
Component: Missing Content (show other bugs)
Version: unspecified
Platform: openSUSE Linux
: NOR normal
Target Milestone: ---
Assignee: Documentation Editorial Team
URL: khelpcenter:M9UrgSUlb6NZkoB
Keywords:
Depends on:
Blocks:
 
Reported: 2022-05-30 10:11 UTC by Christopher Yeleighton
Modified: 2022-06-06 13:37 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments
Bluetooth KCM screenshot (10.55 KB, image/png)
2022-05-30 12:31 UTC, Yuri Chornoivan
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Christopher Yeleighton 2022-05-30 10:11:55 UTC
SUMMARY
There is no documentation for bluedevil available.


STEPS TO REPRODUCE
1. Find the documentation for bluedevil in the Help Centre!

OBSERVED RESULT
Nope

EXPECTED RESULT
The bluedevil tray tool allows you to connect to Bluetooth devices etc.

SOFTWARE/OS VERSIONS
Windows: 
macOS: 
Linux/KDE Plasma: openSUSE Tumbleweed 20220525
(available in About System)
KDE Plasma Version: 5.24.5
KDE Frameworks Version: 5.94.0
Qt Version: 5.15.2

ADDITIONAL INFORMATION
Comment 1 Yuri Chornoivan 2022-05-30 12:31:56 UTC
Created attachment 149330 [details]
Bluetooth KCM screenshot

Not arguing the lack of the help page but the KCM also lacks the "Help" button. It must be a complex solution, otherwise, the work will be unreachable in common sense.
Comment 2 Christopher Yeleighton 2022-06-04 15:16:02 UTC
There is also the Bluetooth file sender window that needs to be documented.  In particular, the documentation must explain that the file sender launches the Obex Manager service and errors out if it is not available, and that the the tray menu lists devices that have been previously connected to, and that each device can be connected or disconnected, and that the command [ + ] can be used to connect to another device, and that the command [ Send file… ], available in the tray menu for each device separately, will be enabled only if the corresponding device is connected and ready to receive files.  This stuff is not KCM-related and a help command in the KCM will not help to figure this out.
Comment 3 Bug Janitor Service 2022-06-06 13:24:12 UTC
A possibly relevant merge request was started @ https://invent.kde.org/plasma/bluedevil/-/merge_requests/80
Comment 4 Nicolas Fella 2022-06-06 13:37:41 UTC
Git commit 84c3bbe4d4bf913f7d0da3a925d997df111603d2 by Nicolas Fella, on behalf of Yuri Chornoivan.
Committed on 06/06/2022 at 13:37.
Pushed by nicolasfella into branch 'master'.

Add basic documentation

M  +1    -0    .kde-ci.yml
M  +3    -0    CMakeLists.txt
A  +3    -0    doc/CMakeLists.txt
A  +-    --    doc/bluetooth-add.png
A  +-    --    doc/bluetooth-configure.png
A  +-    --    doc/bluetooth-kcm.png
A  +-    --    doc/bluetooth-phone.png
A  +-    --    doc/bluetooth-tray.png
A  +239  -0    doc/index.docbook
A  +-    --    doc/list-remove.png
A  +-    --    doc/network-connect.png
A  +-    --    doc/network-disconnect.png
M  +1    -1    src/kcm/bluetooth.cpp

https://invent.kde.org/plasma/bluedevil/commit/84c3bbe4d4bf913f7d0da3a925d997df111603d2