search

CBATeam / CBA_A3

Community Base Addons for Arma 3
https://github.com/CBATeam/CBA_A3/wiki
GNU General Public License v2.0
365 stars 148 forks source link

Wiki documentation #564

Open Bummeri opened 7 years ago

Bummeri commented 7 years ago

Links to to the documentation of these two functions are only found in code section of github:

http://ace3mod.com/wiki/development/arma-3-scheduler-and-our-practices.html#waitandexecute http://ace3mod.com/wiki/development/arma-3-scheduler-and-our-practices.html#waituntilandexecute There were others but I will link them once I find them.

This page: https://github.com/CBATeam/CBA_A3/wiki/Function%20and%20Macro%20Libraries And this page: http://cbateam.github.io/CBA_A3/docs/files/overview-txt.html They just link to eachother via

"See Functions and Macros reference" "Function and Macro Libraries"

I am really glad that CBA is actively taken care of and updated, but it seems the documentation is lagging behind development in the wiki and the reference page. Do you guys have any plans to switch to maintaining only the wikipage or are you planing on keeping both going?

commy2 commented 7 years ago

What else do you need though? The function headers are very descriptive.

Bummeri commented 7 years ago

Indeed they are but they are not linked anywhere other than Ace3 guides it seems. Finding them and even realizing such functions exist is an issue. Sorry for not being more precise.

Cuel commented 7 years ago

The functions page is generated from function headers in CBA, the wiki is written manually

Bummeri commented 7 years ago

Well I do not know how its done or by who, but the point is that those functions linked from the ace wiki are not on the online reference page.

Killswitch00 commented 7 years ago

It's been a while since I updated the function reference (last link above) - I'll get to it as soon as possible. Am away from home for a while, but hopefully this upcoming weekend.

EDIT: online function reference has been updated to be in sync with CBA 3.1.2. For example:

CBA_fnc_waitAndExecute CBA_fnc_waitUntilAndExecute

(The circular reference loop between the wiki and function reference though, that needs improvement)

shadez95 commented 7 years ago

Just to add to this. On the home page of the wiki here it displays...

- [Building CBA from source](Building CBA from source)
- [Submitting content](Submitting content) (functions, macros or patches). This would make your work available to a large audience of developers and save on replicated development.

It seems maybe someone was trying to use markdown and link other pages.

Bummeri commented 5 years ago

Looping links

The looping links