Document how to use startup files

[Lupus590]

Related: #1068

[SquidDev]

Thanks for putting this together! I wonder if it's worth leaving off the section on case sensitivity, and just saying "keep it lower case". It's good content to have, but probably better off in the main fs API.

[SquidDev]

Thank you very much for putting this together! I always forget how terribly even the core bits of functionality are documented.

I think the content is good here, I'm just quite sure about the structure yet. What I'm trying to do with guides¹ is provide something which is relatively incremental - users can follow along, stop at any point, but still have something actionable they can take away from it.

I think right now things are a little confusing because so much is introduced in one go at the beginning, and it's not clear what 'I' can/should do². I think I'd propose splitting the docs into several sections like so:

• startup.lua: Motivation (run program when a computer turns on) and a basic example: "create a startup.lua file and run the reboot program". We have some funky support for mounting code snippets on computers³, so you could have two snippets here: one with the startup file and another just saying "Press the run button to see the startup file in action".

• startup directory: Talk about startup vs startup.lua and the startup/ directory. We could even have another snippet here, talking about creating a startup/another-startup.lua file, mount that along with the previous startup file, and demo it again.

• Starting from disks: Move that "Mass configuration" section to the top (though leave out the stuff on settings for now)! This is a great "why would I want to do this?".

  We can't really demo this in-browser, but can still explain how you'd do this (i.e. move your startup.lua and startup/ files onto a disk and reboot).

  At the end of this section it's probably worth talking about what happens when you've got multiple drives.

• Settings: Mention the two shell.* settings. Possibly anything else you think is relevant?

Footnotes

1. And to be clear, I'm not sure I've been successful yet, even in the stuff I wrote!

   Really I should be following something more structured like the Diataxis Framework, but I really struggle writing in a way which doesn't end up being three kinds of topic in one. Though I probably should move the Lua 5.2/5.3 compatibility stuff into a "Reference" section at least. ↩

2. As always, I'm the worst person to be commenting on docs, because I don't know what beginners need. ↩

3. Worth noting the example runner will override a startup.lua file, but that should be easy to fix - just swap these two elements. Not sure if you've got CC:T's full build environment (and illuaminate) set up locally, so happy to do that bit if you'd prefer. ↩

[Lupus590]

Not sure if you've got CC:T's full build environment (and illuaminate) set up locally

I'm fairly sure that I don't, the proper build steps break before doc gen so I've been calling that manually and it's not produced quite how I expect it to. Some CSS or markdown-to-html might not be working. I wouldn't mind pointers, can do it via discord if it's easier.

Edit: thanks