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.

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

Document Commands #101

Open
schnapster opened this issue Jun 27, 2020 · 4 comments · May be fixed by #134
Open

Document Commands #101

schnapster opened this issue Jun 27, 2020 · 4 comments · May be fixed by #134
Assignees
Labels
component:dashboard Web dashboard size:S Can probably be done in a day or two

Comments

@schnapster
Copy link
Member

The upcoming dashboard website should have a part that documents the commands. Use stuff from the existing website to populate it.

@schnapster schnapster added component:dashboard Web dashboard size:S Can probably be done in a day or two labels Jun 27, 2020
@sario528
Copy link
Contributor

I can handle the actual copy/pasting and formatting. Just show me where to put the info.

@schnapster
Copy link
Member Author

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.

@schnapster
Copy link
Member Author

schnapster commented Jun 28, 2020

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 dashboard subdirectory
  • 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.

@OtterBoops
Copy link
Contributor

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)

@sario528 sario528 linked a pull request Jul 19, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:dashboard Web dashboard size:S Can probably be done in a day or two
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants