Open
Description
Hi,
I would like to improve the documentation of HyperBian in the "Operation" section, but I am missing virtually all information about it.
While the installation and configuration is well described, virtually all information on usage is missing:
- Where is the installation of Hyperion?
- How do I start/stop/restart Hyperion?
- How do I get logs files?
etc
Do you guys see it the same way?
Then I would start collecting this info together and submit a PR.
LG Sören
Metadata
Metadata
Assignees
Labels
No labels
Activity
nvtkaszpir commentedon Sep 4, 2022
sudo systemctl start hyperion
(or replacestart
withstop
journalctl -u hyperion
should be sufficient with modern operating systems)[-]Improve Operation usage documentation[/-][+]Improve Operation usage documentation of HyperBian[/+]pattyland commentedon Sep 14, 2022
@nvtkaszpir I'm sorry that you have now taken the trouble to formulate a good answer to my stupidly worded question.... I wrote this query after I installed HyperBian, there the documentation just stops after the installation part.
There is no "normally" and "if" but it should be clearly defined what is where: https://docs.hyperion-project.org/en/user/HyperBian.html#requirements
nvtkaszpir commentedon Sep 14, 2022
@pattyland yes you are right, I believe docs are lacking in that matter, I believe
Installation
section needsRunning Hyperion
section.Now there is only
Install -> Requirements/Install/.../Uninstall
and thenConfiguration
.Looks like
Run Hyperion
is completely missing - yet is quite crucial - but it varies depending on the running operating system (kind of standalone in CLI, as service (systemd/initd and so on), not to mention that for example there is no explanation between hyperiond or hyperion-x11 and other binaries, which is quite important.I believe it was just left by accident because sometimes things are so obvious for experienced users that people forget about the inexperienced/newcomers :)
Any thoughts about structuring that docs section, @Lord-Grey ?