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

Rewrite Documentation #11

Open
2 of 11 tasks
markhughes opened this issue Jun 2, 2016 · 0 comments
Open
2 of 11 tasks

Rewrite Documentation #11

markhughes opened this issue Jun 2, 2016 · 0 comments
Labels
Documentation / Wiki

Comments

@markhughes
Copy link
Owner

markhughes commented Jun 2, 2016 •
edited
Loading

The documentation at present is not too good, here is what needs to be done:

  • All API specific code documented, so javadocs can be created
  • New wiki documentation

The new wiki documentation will consist of:

  • Existing home, with links to points of interest, plus a small table of contents
  • New page: Setting up development environment
  • New page: Using FPlayer/FPlayers
  • New page: Using Faction/Factions
  • New page: Listening to Events
  • New page: Creating Commands
  • New Page: Existing Plugins

Example repo should be created outlining:

  • Basic Event and FPlayer usage
  • Basic Command creation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation / Wiki
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@markhughes