Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wiki documentation #564

Open
Bummeri opened this issue Dec 13, 2016 · 7 comments
Open

Wiki documentation #564

Bummeri opened this issue Dec 13, 2016 · 7 comments

Comments

@Bummeri
Copy link

Bummeri commented Dec 13, 2016

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
Copy link
Contributor

commy2 commented Dec 13, 2016

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

@Bummeri
Copy link
Author

Bummeri commented Dec 14, 2016

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
Copy link
Contributor

Cuel commented Dec 14, 2016

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

@Bummeri
Copy link
Author

Bummeri commented Dec 15, 2016

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
Copy link
Contributor

Killswitch00 commented Dec 15, 2016

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)

@commy2 commy2 added this to the Backlog milestone Jan 18, 2017
@commy2 commy2 added the Task label Mar 5, 2017
@shadez95
Copy link
Contributor

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.

@commy2 commy2 modified the milestones: Backlog, Ongoing Jul 23, 2018
@commy2 commy2 changed the title Wiki documentation update needed Wiki documentation Jul 23, 2018
@Bummeri
Copy link
Author

Bummeri commented Nov 4, 2018

Looping links

The looping links

@commy2 commy2 pinned this issue Nov 2, 2019
@jonpas jonpas closed this as completed Sep 7, 2023
@jonpas jonpas reopened this Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants