search

OpenMods / OpenPeripheral

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

Documentation for all OpenMods #106

Closed richardcooper closed 10 years ago

richardcooper commented 10 years ago

Following on from ticket #105 which is now closed.

Documentation for openperipheral is now fully in-game, using "openp/docs [side]".

I think that would be worth mentioning on the website. Otherwise how are people going to know to run openp/docs

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.

There's a lot more to documentation than just the recipes, especially for OpenBlocks which doesn't have the in-game documentation. If you don't want to maintain the docs yourself then how about linking to the github wikis from openmods.info homepage

tomjn commented 10 years ago

+1 I may add current direwolf 1.6.4 pack there is no openp/docs program on an advanced computer, and no openp folder on either advanced/non-advanced turtle. Googling directs the use to the website which promptly redirects to the homepage where no instruction on how to find documentation is available or mentioned.

Currently to get documentation, you need to discover this repository ( which I would never have found if I wasn't already a developer ), and manually grab the docs lua source.

Once downloaded, I used the docs program on an AE controller, and got multiple pages worth of information, but could only see the last screens worth

SinZ163 commented 10 years ago

Ancient versions of openperiperal are not supported

SinZ163 commented 10 years ago

Also, if the stock program doesn't fit your needs, write your own.

All the info is in p.getAdvancedMethodsData()

richardcooper commented 10 years ago

My initial comment has nothing to do with ancient versions of openperiperal

tomjn commented 10 years ago

He was referring to my use of the direwolf pack, not the hard to find documentation that isn't mentioned anywhere.

I can understand that documentation takes time to write, and that an openp/doc command is a quick means of letting people know what methods are available, and hope that the names are descriptive enough, but it's not mentioned anywhere ( why was such an ancient version bundled with the latest FTB pack anyway? )

If the old documentation page was restored, but had a only single sentence "Documentation is no longer available here, but there's a computercraft command openp/docs " that would itself be a _massive_ improvement, and would take all of 5 minutes to implement.

SinZ163 commented 10 years ago

To answer the question about ancient version in the FTB packs, you would need to ask jadedcat

On Thu, Jan 30, 2014 at 11:10 PM, Tom J Nowell notifications@github.comwrote:

He was referring to my use of the direwolf pack, not the hard to find documentation that isn't mentioned anywhere.

I can understand that documentation takes time to write, and that an openp/doc command is a quick means of letting people know what methods are available, and hope that the names are descriptive enough, but it's not mentioned anywhere ( why was such an ancient version bundled with the latest FTB pack anyway? )

If the old documentation page was restored, but had a only single sentence "Documentation is no longer available here, but there's a computercraft command openp/docs " that would itself be a massive improvement, and would take all of 5 minutes to implement.

— Reply to this email directly or view it on GitHubhttps://github.com/OpenMods/OpenPeripheral/issues/106#issuecomment-33682171 .

SinZ