Rewrite Documentation - Githubissues

markhughes / FactionsFramework

Build a Factions plugin for every version of Factions and not have to worry about version upgrades and changes.

GNU General Public License v3.0

5 stars 3 forks source link

Rewrite Documentation #11

Open markhughes opened 8 years ago

markhughes commented 8 years ago

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:

[x] Existing home, with links to points of interest, plus a small table of contents
[x] 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