forked from dan/liminix
1
0
Fork 0
Commit Graph

85 Commits

Author SHA1 Message Date
Arnout Engelen 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 f81aa54444 rename file 2023-09-17 17:03:56 +01:00
Daniel Barlow 56261f77b0 add example with real hardware 2023-09-17 17:03:56 +01:00
Daniel Barlow 8600dfc8cf proofread v2 2023-09-17 17:03:56 +01:00
Daniel Barlow bb280c6d97 rename qemu example 2023-09-17 17:03:56 +01:00
Daniel Barlow b7e805c97f connecting a client to hellonet 2023-09-17 17:03:56 +01:00
Daniel Barlow 9223fa7ec4 first proofreading pass 2023-09-17 17:03:56 +01:00
Daniel Barlow 0f31afee2b hellonet: set password for root
otherwise incoming ssh gets a bit fraught
2023-09-17 17:03:56 +01:00
Daniel Barlow c6faf88dd1 doc WIP: build "hello net" example 2023-09-17 17:03:56 +01:00
Daniel Barlow 625146d821 escape backslash in service type 2023-08-16 22:26:40 +01:00
Daniel Barlow bd908307c4 print module pathname if it contains services
so that the user knows what to add to their imports
2023-08-16 22:26:40 +01:00
Daniel Barlow d7785d9d75 if no preamble, print module pathname as headline
this was supposed to work already but was broken
2023-08-16 22:26:40 +01:00
Daniel Barlow 519de0b55c module docs: service modules are listed after plain modules 2023-08-12 20:10:40 +01:00
Daniel Barlow f20d1cfc01 print description only if present 2023-08-12 18:16:20 +01:00
Daniel Barlow e039783e67 exclude outputs from doc 2023-08-12 18:16:06 +01:00
Daniel Barlow dc4b7ebffd module docs: print examples 2023-08-11 21:12:57 +01:00