Add Documentation
Closed this issue · 4 comments
Add a wiki here on GitHub for HexNicks.
https://github.com/Majekdor/HexNicks/wiki
Documentation Needed 📘
- Commands
- Permissions
- Color Formatting
- Built-In Chat Formatter
- Developer API Usage
- How to use with Essentials
- Legacy color explanation
- Placeholder Information
- Example Nicknames
- Config Options
If anyone has anything else they believe should be documented comment on this issue.
@Majekdor Hi, also in NC (RDU area). Do you need assistance with documentation? I'm a technical writer.
Hi! I'm not sure I need someone with your skill set. This issue was more just for me to remember what all I need to document and for anyone else to comment what should be documented.
-all commands that are actively used for the plugin
-all perms listed for the plugin and what commands/properties they handle
-all placeholders listed and what they do
-some sort of documentation talking about chatformatting maybe even linking them the chatformatting plugin
-brief description of what mini message is and basics on how to use it?
-documentation on how the gradient command works and alot of examples for /nickcolor <gradient...>
-possibly a video to show case its uses
-link to old color formatting aka &6, &b, &d etc and explanation on how that works
-bascially provide more example for use case
-def have sarge in there somewhere