search

nix-community / nix-on-droid

Nix-enabled environment for your Android device. [maintainers=@t184256,@Gerschtli]
https://nix-on-droid.unboiled.info
MIT License
1.16k stars 65 forks source link

Add html and man pages for available options #211

Closed Gerschtli closed 1 year ago

Gerschtli commented 1 year ago

Adds rendered list of available options. We could potentially thinks about moving github wiki, readme and changelog documentation to these html pages.

For local testing, run 

nix build ".#manualHtml"
open result/share/doc/nix-on-droid/index.html

nix build ".#manPages"
man --local-file result/share/man/man5/nix-on-droid-options.5.gz

This PR contains also a new github workflow to automatically deploy latest docs to gh pages on every master push.

Fixed some option descriptions for correct formatting and renamed Nix-on-Droid occurrences to nix-on-droid for consistency.

Interesting, potential follow-up tasks:

Requires https://github.com/t184256/nix-on-droid/pull/204. Solves https://github.com/t184256/nix-on-droid/issues/36.

Gerschtli commented 1 year ago

Force push was only rebase on master

Gerschtli commented 1 year ago

Oh cool, there is a "Compare" button to see what changed between force-pushes. Not sure if I never saw it or it was added recently, but then we can just autosquash before pushing and still be able to see the differences :)

Gerschtli commented 1 year ago

Casing: should Android app also lowercase it now? IMO this would look rather odd on Android. (suggestion: lowercase when monospace, heh)

Good point. We can try to do that :D

_module.args

I tried to hide it, didn't manage to do so. Basically, it is an option you can use, so it is not completely wrong :D Also home-manager docs has (obviously, because of nmd) the same behaviour.

Gerschtli commented 1 year ago

Tried to find a consistent way for the casing, what do you think?