Document Commands
schnapster opened this issue · comments
The upcoming dashboard website should have a part that documents the commands. Use stuff from the existing website to populate it.
I can handle the actual copy/pasting and formatting. Just show me where to put the info.
I can try to prepare something, but I don't really have a Grand Vision for most parts of the dashboard, feel free to have a go yourself and put it wherever you want.
Here's the dev docs for the dashboard:
https://github.com/wolfiabot/Wolfia/tree/master/dashboard#dashboard-dev-docs
Other than that, the Vue docs might be helpful, although the content will be static so all we probably need is component with a styled template.
Nvm you don't need the whole setup with ngrok and the backend at all, since commands should be visible to any user when they visit the site without logging in.
Here are the simpler steps:
- Install npm / yarn
- Checkout the repo
- Go to the
dashboardsubdirectory - Run
yarn install - Run
yarn serve - Open browser at https://localhost:8080
Now you can edit the files in dashboard/src.
I'd wager creating commands components that has all the content (including a route and a menu entry) would be sufficient.
The navbar is already a little cluttered. I suggest a dropdown menu for everything that's related to the bot itself (commands, game modes, whatever else)