EQEmulator Forums

EQEmulator Forums (http://www.eqemulator.org/forums/index.php)
-   General::News (http://www.eqemulator.org/forums/forumdisplay.php?f=594)
-   -   Complete Emulator Project Documentation Refresh 2018 (http://www.eqemulator.org/forums/showthread.php?t=41656)

Akkadius 07-02-2018 04:58 PM

Update

LUA API: https://github.com/EQEmu/Server/wiki/Lua-API
Perl API: https://github.com/EQEmu/Server/wiki/Perl-API

Perl Source Parser: https://github.com/EQEmu/Server/blob...-doc-parser.pl

LUA Source Parser: https://github.com/EQEmu/Server/blob...-doc-parser.pl

I've been looking at quite a few other solutions for docs, everything has circled me back to simply using Github Wiki for our docs, its not perfect but it pretty much takes care of everything that we need, so we will be going forward using it for the foreseeable future

I've updated a ton of docs on the Github Wiki and most things can be found on the Navbar on the right, still tons to do but we're looking pretty good so far

If you're interested in helping with our documentation, join the #docs-chat channel on Discord

fzzzty 07-06-2018 09:35 AM

A wiki is definitely your best bet. Confluence is the best, but it's not free, so GitHub is probably the next best thing. I'll definitely help out with this as I'm learning and really finding very little useful information out there...

Akkadius 07-06-2018 03:37 PM

Quote:

Originally Posted by fzzzty (Post 259165)
A wiki is definitely your best bet. Confluence is the best, but it's not free, so GitHub is probably the next best thing. I'll definitely help out with this as I'm learning and really finding very little useful information out there...

Confluence is garbage, I wrote the Wiki engine we used for 5 years which we've been moving content off of onto Github

I'd like to finish my last iteration of my Wiki engine but my work in the Valley has me way too busy to do so, so I put a full stop on it in the meantime and Github is plenty fine

I've scoured the internet for the years and I know just about every documentation system out there. I recently looked at some newer alternatives such as Gitbook.com - the guys from France launched v2 of their platform and while it has a lot of very solid elements, its too bug ridden for me to even work with right now. Github is not perfect but it has everything that we need and we'll just have to deal with it because we have a lot of things to get moved over from our older knowledge bases and also refresh on. We've been making a lot of strides recently.

A lot of us working on this project are very slim on time, but I will be knocking out a handful of articles here and there depending on how time permits. There have been a handful of other people who have been putting in good efforts as well. What we have populated so far is looking really good. If you are willing to help, hit us up in #docs-chat on Discord

Splose 07-07-2018 02:04 AM

Quote:

Originally Posted by Akkadius (Post 259166)
Confluence is garbage, I wrote the Wiki engine we used for 5 years which we've been moving content off of onto Github

I'd like to finish my last iteration of my Wiki engine but my work in the Valley has me way too busy to do so, so I put a full stop on it in the meantime and Github is plenty fine

I've scoured the internet for the years and I know just about every documentation system out there. I recently looked at some newer alternatives such as Gitbook.com - the guys from France launched v2 of their platform and while it has a lot of very solid elements, its too bug ridden for me to even work with right now. Github is not perfect but it has everything that we need and we'll just have to deal with it because we have a lot of things to get moved over from our older knowledge bases and also refresh on. We've been making a lot of strides recently.

A lot of us working on this project are very slim on time, but I will be knocking out a handful of articles here and there depending on how time permits. There have been a handful of other people who have been putting in good efforts as well. What we have populated so far is looking really good. If you are willing to help, hit us up in #docs-chat on Discord

I will get with you soon about the scaling system and some zonecontroller/player.pl tutorials.


All times are GMT -4. The time now is 10:42 AM.

Powered by vBulletin®, Copyright ©2000 - 2020, Jelsoft Enterprises Ltd.