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

Scriptdocumentation #2

Closed
D4edalus opened this issue Apr 10, 2016 · 9 comments
Closed

Scriptdocumentation #2

D4edalus opened this issue Apr 10, 2016 · 9 comments

Comments

@D4edalus
Copy link
Contributor

Translate/rewrite scriptdocumentation folder to markup
add information for main_shared

@florczakraf
Copy link
Contributor

florczakraf commented Jul 13, 2016

Working on it. No ETA since I work full-time. I will create PR once I think it's ready for review.

@florczakraf
Copy link
Contributor

Here's a demo: https://github.com/florczakraf/CoD4x_Server/blob/script-documentation/scriptdocumentation/script_functions_reference.md

Let me know what you think before I continue my work on it. IMO it should eventually become a wiki article (but due to lack of Github's support for wiki pull request it's better to keep it this way for now).

@IceNinjaman
Copy link
Collaborator

Well we are always happy if someone is going to help with documentation. Thank you.

@PureTryOut
Copy link
Contributor

Good job! That's looking really good already!

@florczakraf
Copy link
Contributor

#31 is up for review.

@PureTryOut
Copy link
Contributor

Is this fixed by #31 or do you guys also want documentation of all non-Cod4X specific functions? I believe there is a site already that does that, but it would probably be good to have it here as well.

@T-Maxxx
Copy link
Contributor

T-Maxxx commented Aug 23, 2016

I think, you should keep this issue opened for all new contributors who doesn't know about documentation.

@PureTryOut
Copy link
Contributor

Honestly, I disagree. Issues exist to be resolved. If resolved, close it.
If people do not see a folder called scriptdocumentation in the main repo, or are not willing to search for documentation, they should honestly not create mods in the first place.

If needed, you could add a link to the scriptdocumentation folder in the README and the wiki, but don't keep an open issue around just to tell people there is documentation.

@D4edalus
Copy link
Contributor Author

D4edalus commented Sep 5, 2016

if necessary we can ask ppl for a few lines of documentation in the pullrequests :)

@D4edalus D4edalus closed this as completed Sep 5, 2016
T-Maxxx added a commit that referenced this issue Aug 23, 2017
IceNinjaman pushed a commit that referenced this issue Sep 10, 2018
D4edalus added a commit that referenced this issue Sep 10, 2018
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

5 participants