search

OpenMods / OpenPeripheral

https://openmods.info
MIT License
67 stars 25 forks source link

All documentation gone from OpenPeripherals website #105

Closed richardcooper closed 10 years ago

richardcooper commented 10 years ago

http://www.openperipheral.info/openperipheral/ is currently a 404. That is the URL which is linked from Mikeemoo's minecraft forum thread, https://github.com/OpenMods/OpenPeripheral, various modpack wikis, reddit threads and generally all over Google.

http://www.openperipheral.info/ doesn't seem to have any links to documentation for openperipheral or any of the open mods.

mikeemoo commented 10 years ago

All old links now redirect to the homepage.

Documentation for openperipheral is now fully in-game, using "openp/docs [side]". Aside from that, there is no documentation. Little point in documenting recipes and stuff these days as the majority of people use NEI or similar.

prozacgod commented 10 years ago

Could you bring back the online docs - I don't need recipes, Just the API. The ingame documentation is just terrible to use on those computers.

Maybe, you can make it part of the build process, and export it as html files into the wiki here on github if you're not wanting to maintain multiple versions or something.

mikeemoo commented 10 years ago

No. Sorry. Write your own in game program for docs if you're not happy with the default.

theoriginalbit commented 10 years ago

theres also a few alternatives that've been made already, you can find them on the ComputerCraft forums.

Wiiplay123 commented 9 years ago

I really prefer to read the online documentation for a mod, so I can multitask while programming.

SinZ163 commented 9 years ago

Except the online documentation is a pain to maintain as it effectively needs to be documentation for every possible block and item in the game

boq commented 9 years ago

Really, that again? Ok, just to clarify - offline documentation is IMPOSSIBLE (also, terribly impractical). We create adapters in runtime, so result depends on multiple factors (installed mods, configuration, state of objects). And for any configuration there might be few hundreds different method sets possible (one for every block).

Though you can see all that data with command op_dump <file>, which will save everything to xml file. It's not pretty (maybe someday there will be converter to HTML? XSLT?), but everything else is impossible.

Edit by @nevercast : XSLT/HTML was later done. https://github.com/OpenMods/OpenPeripheral/pull/219 2015-03-25