The Big Wiki issue

[payonel]

We need to get our wiki documentation to an awesome level of correctness

Rules/Details about this ticket:

1. This is the one "documentation needed" to rule them all
2. This list should include any/all missing/incomplete/inaccurate wiki pages
3. This issue is to track http://ocdoc.cil.li/ issues ONLY. In-game manual, tooltips, etc. are not for this ticket
4. I will delete your comments here like sub-tasks as I include their suggestions to this list
5. github tickets that deal with documentation needs will be closed as dups of this ticket.
6. Please vote for pages that are higher priority than others (in comments)
7. Add comments for pages not on this list. Give specific details if needed

Thank you!

• [ ] make template for component api
  • verify api matches current callbacks in source
• [ ] make template for openos library api
• [ ] make template for machine library api (what is available from "bare metal")\
• [ ] make template for signals
  • separate http://ocdoc.cil.li/component:signals into individual signal pages using template
  • reference signal on the related component
  • reference all signals on main signal page
• [ ] use templates in all current pages
  • separate pages that try to do both, like openos filesystem (cross link)
• [ ] http://ocdoc.cil.li/block:server_rack update this
  • Internal/external mode is no longer applicable, it uses Enabled/Disabled
• [ ] http://ocdoc.cil.li/component:modem "wake-up messages" aren't explained
• [ ] http://ocdoc.cil.li/block:transposer broken image link
• [x] openos rc tool documentation
• [ ] http://ocdoc.cil.li/item:loot_disks loot disks are no longer actually loot disks
• [ ] Add a page describing how to get api doc in the lua repl
• [x] http://ocdoc.cil.li/api:internet fix internet.request's documenation
• [ ] http://ocdoc.cil.li/item:terminal
  • detail how to use the remote terminal with racks in various configurations and rack slots
• [x] http://ocdoc.cil.li/component:redstone getBundledOutput returns a table if 2nd arg is nil
• [ ] a place to describe soft and hard interrupts. probably deserves a link on the landing page
• [x] http://ocdoc.cil.li/item:hover_boots specify that only the oc charger is supported
• [ ] http://ocdoc.cil.li/item:eeprom give details about available api and custom oses from here
• [x] http://ocdoc.cil.li/tutorial:autorun_options start up scripts need a real explanation
• [ ] http://ocdoc.cil.li/item:wireless_network_card add t1 wireless cards
• [ ] http://ocdoc.cil.li/openos elaborate on how to use the command line interface, and -- switch
• [ ] http://ocdoc.cil.li/block:access_point update refs to indicate that it is deprecated
• [ ] http://ocdoc.cil.li/component:modem demo how to send messages
• [ ] update known signals https://gist.github.com/xarses/7bf0a483220cd204b96fb9a30e947db2
• [ ] http://ocdoc.cil.li/block:geolyzer should have a note somewhere that is can be used as an upgrade
• [ ] add a page about the MFU (the remote adapter than vex refuses to name)
• [ ] show how to share memory between programs using _G
• [ ] add a page and link details "relative vs absolute paths"
• [ ] make sure eeprom swapping is documented (shift right clicking, and recrafting)
• [x] http://ocdoc.cil.li/component:drone add available robot api
• [ ] http://ocdoc.cil.li/component:trading expand this page and add page for the upgrade (red link)
• [ ] detail crafting on robots, including that the selected slot can interfere with crafting
• [x] review the term docs, clean up old refs to window
• [ ] explain power flow in the network, #1823
• [x] explain the sides api in context of a robot and inventory, #2871
• [ ] tier 1 wireless details
• [ ] build guide

[skyem123]

Something else that needs to be updated is the whole setup of the development environment guide, it doesn't work as Idea and Gradle have updated and behaviours have changed... it can be made to work, but it isn't fun and is very trial-and-error

[CraigKnoblauch]

I'm a new user and after several hours of getting started in open computers I can definitely feel the pain of limited docs. I'd like to contribute to this issue if I could. @payonel Can I start contributing to this issue?

[payonel]

definitely :) just pick an item on the list, or any page you feel is under documented, and start writing :) it is an open wiki

[SpaceBeeGaming]

Examples of the data card functions would be good to have. Currently explains what they do but not how to use them.

[AmandaCameron]

ASsuming "Build Guide" is regarding using it in IntelliJ, you already commented something like it in a previous issue might be worth copying into the wiki as a "Contributing to OC"

[AnonymousDapper]

I would appreciate documentation for devfs.

I've managed to reverse engineer it enough to work, but an actual wiki page would be appreciated.

I can write up a template later if someone familiar with the lib wants to check it.

[finnaminope]

I Think Docs on Virtual Drives Would Be Nice. I Don't Know If This is A Duplicate of the above