Daniel Barlow
528afae8b1
doc: punctuate
2024-08-06 14:15:57 +01:00
Daniel Barlow
384835c89d
admin doc: updte round-robin, explain health check
2024-08-06 14:14:52 +01:00
Daniel Barlow
5051625d31
mention health check in docs
2024-07-30 22:53:21 +01:00
Daniel Barlow
8091e207b6
some notes on controlled services
2024-07-28 22:57:23 +01:00
Daniel Barlow
df395a4d5d
finish moving pkgs.linimix.callService to config.system
2024-07-15 19:00:08 +01:00
Daniel Barlow
1c3242cab1
doc: swap order of configuration and installation
...
you can get a device up and running using a lightly edited example
config before you need to read all the reference info, so let's
have the documentation in that order.
2024-07-14 12:26:07 +01:00
Daniel Barlow
bc9ced5d38
fix doc ref from admin section -> configuration
2024-07-14 11:56:35 +01:00
Daniel Barlow
d34919766a
improve reinstallation docs
2024-07-12 18:38:04 +01:00
Daniel Barlow
2fe0cd2f48
add first draft instructions for using Levitate
2024-07-12 00:17:25 +01:00
Daniel Barlow
241f1013ed
add new Installation guide
...
move the u-boot/serial stuff here from development, as the
reality of Liminix development in 2024 is that serial connection
is still the smoothest installation method
2024-07-11 23:31:00 +01:00
Daniel Barlow
3f8cc24dcc
fix most doc warnings
2024-07-10 23:36:24 +01:00
Daniel Barlow
57e3b449f8
proofreading
2024-07-10 21:23:24 +01:00
Daniel Barlow
3964505131
some notes on services
2024-07-10 20:50:08 +01:00
Daniel Barlow
3df1ec76ff
cleanup whitespace and commas
...
* [] is now [ ]
* {} is now { }
* commas in arglists go at end of line not beginning
In short, I ran the whole thing through nixfmt-rfc-style but only
accepted about 30% of its changes. I might grow accustomed to more
of it over time
2024-06-30 17:16:28 +01:00
Daniel Barlow
e94bf62ec1
remove dead code (run deadnix)
2024-06-29 22:59:27 +01:00
d5026c2074
docs: add hardware recommendation
...
Also add infrastructure to also generate the supported hardware
page when building the docs locally
2024-01-04 14:35:00 +01:00
Daniel Barlow
876bd7d8ce
rename flashimage to mtdimage
2023-12-11 19:09:18 +00:00
Daniel Barlow
15d570f749
ignore devices/families when extracting docs
2023-12-09 17:10:41 +00:00
Daniel Barlow
a0bd250963
switch from getty to root shell on console
...
this just makes things marginally simpler
2023-11-21 23:09:48 +00:00
Daniel Barlow
f61e737b54
improve doc for outputs and hardware
...
Changed my mind about "installer" as a first-class concept, at least
in the current implementation. Not every documented output is an
installer
2023-11-12 17:15:58 +00:00
Daniel Barlow
262efaabe6
doc: put all the u-boot/serial stuff in one place to link from
2023-11-12 17:14:33 +00:00
Daniel Barlow
7cfb92e3ce
more doc
2023-11-10 21:17:20 +00:00
Daniel Barlow
5e046490de
support links from device pages to their installation methods
2023-11-09 23:02:35 +00:00
Daniel Barlow
5729cfb4a7
document installation methods (only vmroot yet)
2023-11-09 22:14:31 +00:00
Daniel Barlow
7d5c7b9b44
export evaluation from default.nix and use it for docs
2023-11-09 22:14:31 +00:00
Daniel Barlow
c94d12934f
remove direct use of run-liminix-vm from tests and doc
2023-11-05 20:37:23 +00:00
Daniel Barlow
f9f934b40c
spell GL.iNet consistently in docs
2023-09-28 23:22:54 +01:00
Daniel Barlow
e3c8ab351e
fix sphinx warning
2023-09-28 12:19:48 +01:00
Daniel Barlow
7e13eda490
add hardware device descriptions to doc
...
most of the text is recycled and follows no particular format
2023-09-28 12:17:30 +01:00
Daniel Barlow
74f4e0a2f3
fiddle with manual layout
2023-09-27 13:44:26 +01:00
Daniel Barlow
9133475103
update tutorial discussion of liminix-rebuild
2023-09-27 11:05:06 +01:00
Daniel Barlow
d0c2b3b274
explain the "demo" example
2023-09-26 18:24:40 +01:00
Daniel Barlow
1673a71831
WIP third example
2023-09-24 23:11:28 +01:00
Daniel Barlow
3a3ee8bbbd
fix CI doc error
2023-09-20 21:31:38 +01:00
Daniel Barlow
4389fa15f7
rename mips-vm as run-liminix-vm
2023-09-20 18:33:20 +01:00
Daniel Barlow
12b9feb8ee
using openwrt mtd command, advide erase before writing
2023-09-18 10:59:55 +01:00
Daniel Barlow
b3a7a2246d
tutorial: move the warning nearer to the decision point
2023-09-17 21:53:15 +01:00
Daniel Barlow
6674344021
don't end chapter with ellipsis
2023-09-17 21:47:09 +01:00
Daniel Barlow
c81ee62374
doc: proofread admin section, add link to TFTP
2023-09-17 21:44:32 +01:00
Daniel Barlow
dd0b1734c1
how to write a module
2023-09-17 21:32:22 +01:00
Daniel Barlow
0a2588013a
include generated module options
2023-09-17 17:47:04 +01:00
Daniel Barlow
71b583a756
copy "how to flash" from the old docs
2023-09-17 17:36:02 +01:00
Daniel Barlow
e72d78ab64
restore intro
2023-09-17 17:03:56 +01:00
Daniel Barlow
17035ca3b7
outline of the missing doc sections
2023-09-17 17:03:56 +01:00
Daniel Barlow
dece70b336
link to ADR
2023-09-17 17:03:56 +01:00
Daniel Barlow
50ea144dec
mention service dependencies
2023-09-17 17:03:56 +01:00
Daniel Barlow
fc84435985
improve syntax blah
2023-09-17 17:03:56 +01:00
Daniel Barlow
06b725cb77
document the module-based-services decision
2023-09-17 17:03:56 +01:00
Daniel Barlow
c74543c4ff
doc: how to define an s6 service
2023-09-17 17:03:56 +01:00
Daniel Barlow
54526c1e11
start writing configuration guide
2023-09-17 17:03:56 +01:00
Daniel Barlow
Arnout Engelen