ULX Documentation

[iViscosity]

I wanted to make an "unofficially official" documentation of ulx utilities, commands, etc. like the ULib documentation. And I just wanted to get all the information from you guys, as well as some of my own.


_{If you mods have any issues with me doing this, just let me know I can take this down}


Will add more in as we go.

[Megiddo]

We have absolutely no problem with you making documentation for ULX on your own and advertising it on the forums. I just want to give you a heads up that we are working on the next generation ULX, which does/will have documentation built in. We have no firm date when we will finish ULX4. It's probably at least six months out.

If you would like our official sponsorship/advocacy/hosting of the ULX documentation you create, we are happy to do so if it's of similar quality to the current ULib documentation. Can you please proceed with documentation for some module or a few functions and send it our way to see what you have in mind? Are you going to use Natural Docs? If so, we would then simply include the comments you generate in the ULX source code.

We are happy to answer questions and provide information however we can. Our time is unfortunately pretty limited, so scheduled voice chats would probably be the best way to give you the information you need.

[Stickly Man!]

^ seconded.

We'll be happy to answer any questions as needed. Partially complete community docs are likely better than no docs at all- We have unfortunately not had the time to get around to it.

[iViscosity]

If you would like our official sponsorship/advocacy/hosting of the ULX documentation you create, we are happy to do so if it's of similar quality to the current ULib documentation. Can you please proceed with documentation for some module or a few functions and send it our way to see what you have in mind? Are you going to use Natural Docs? If so, we would then simply include the comments you generate in the ULX source code.

Sorry, internet has been buggy for the past couple of days so I couldn't respond. I'll likely be using Natural Docs as it seems easy to use and similar to what you already have for ULib.

If I do go that route, my Discord is likely the best place for me to have Voice Chats. If that is the case, it's in my Signature.

[iViscosity]

Secondly, as I'm not 100% knowledgeable about ULX functions and such, I was hoping you could help out a bit either helping pointing me to the right areas to look, or giving me some yourselves, just to make this easier.


EDIT: May I ask what file extension you used when making the ULib documentation? I want to make it as similar as possible to how you made it.


EDIT2: What I meant by that is, how did you define the lua extension for Natural Docs?

[Megiddo]

Attached is the ND config for ULib. There's nothing to it other than this, our ND setup pulls the comments directly out of Lua files on GitHub to generate the documentation.

[iViscosity]

Thank you Megiddo for that. To make this Documentation a little bit easier to do, I'd like to ask you or just other members of the community for the things they know and maybe links. I've been using the Github to find the functions for things, but I think this would just make it a bit easier.

Also, how did you guys get it to automatically pull them off the Github? I'd like to make something like that.

[iViscosity]

Completely forgot about this, sorry guys!

I asked this in the first post, but I'd like to get as much info from the community as possible, things like functions you know (ulx.fancyLog(admin)), etc. etc., and basically what they do. Link to the Github Repository I'm working on right now is here. If you want to add, please make a fork, make your changes, and start a pull request. I will check these frequently. I will not accept any pull requests that don't follow the format; take a look at messages.lua for an example.