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.

Sign up for GitHub

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

Jump to bottom

Documentation pt.2 #613

Merged
merged 6 commits into from
Jun 23, 2019
Merged

Documentation pt.2 #613

merged 6 commits into from
Jun 23, 2019

Conversation

Dubjunk
Copy link
Contributor

@Dubjunk Dubjunk commented May 16, 2019 •
edited by Wyqer
Loading

Q A
Bug fix? no
New feature? no
Needs wipe? no
Fixed issues #508

Description:

Various documentation work on the new framework.

Content:

  • Documentation for the general structure of the framework
  • Module information via readme and Wiki/Website
    • Init
    • Common
    • Core
    • Persistance
    • Respawn
    • Admin
    • Resources
    • Permission
    • Arsenal
    • Player menu
    • Virtual
    • Build
    • Garrison
    • Logistic
    • Enemy
    • Cratefiller
  • Functions library (for public functions)
    • Public function attribute for every function
    • Optional: Examples for each function
  • Instructions how to add a module from scratch via the provided example module
  • Our basic coding conventions/contribution guidelines for the public
  • Replacement of the diag_log function with our own logging function KPLIB_fnc_common_log
  • More stuff which will be added here

@Dubjunk Dubjunk added this to the Sprint 13 milestone May 16, 2019
@Wyqer Wyqer removed this from the Sprint 13 milestone Jun 15, 2019
@Wyqer Wyqer marked this pull request as ready for review June 23, 2019 13:35
@Wyqer Wyqer requested review from veteran29 and Wyqer June 23, 2019 13:35
@Wyqer Wyqer added this to the Sprint 13 milestone Jun 23, 2019
Wyqer
Wyqer approved these changes Jun 23, 2019
View reviewed changes
Copy link
Member

@Wyqer Wyqer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least one of us, who has done some documentation. ;)

@Wyqer Wyqer merged commit e71ce77 into v0.97S13 Jun 23, 2019
@Wyqer Wyqer deleted the v0.97S13-508 branch June 23, 2019 14:22
@Wyqer Wyqer added done and removed review/QA labels Jun 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Wyqer Wyqer Wyqer approved these changes

@veteran29 veteran29 Awaiting requested review from veteran29

Assignees

@Wyqer Wyqer

@veteran29 veteran29

Labels
None yet
Projects
None yet
Milestone
Sprint 13
Development

Successfully merging this pull request may close these issues.
3 participants
@Dubjunk @Wyqer @veteran29