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

Refactor sections #14

Open
23 tasks
JordanSussman opened this issue Sep 20, 2018 · 1 comment
Open
23 tasks

Refactor sections #14

JordanSussman opened this issue Sep 20, 2018 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@JordanSussman
Copy link
Collaborator

JordanSussman commented Sep 20, 2018 •
edited by wass3r
Loading

@wass3r - any thoughts on changing the current layout to look more like the following?

Getting Started

  • Installation
    • Docker
    • Cli
    • Go get
  • Cli Usage
  • Configuration

Architecture

  • Index with diagram

Remotes

  • Index talking about current remotes and desire for more
  • Slack
  • Discord

Actions

  • Index with brief explanation
  • HTTP
  • Exec
  • Log
  • Message

Rules

  • Index with brief explanation
  • Anatomy of a Rule
  • Variables
  • Examples

Deployment?

  • Heroku?
  • Kubernetes?
  • Helm chart?

Acknowledgements

  • Index with people/projects
@JordanSussman JordanSussman added enhancement New feature or request help wanted Extra attention is needed labels Sep 20, 2018
@wass3r
Copy link
Collaborator

wass3r commented Nov 18, 2018

I think this looks good, but I feel like the whole thing should lead with super simple snippets of a bot.yml and a hello-world.yml. Maybe even a gif of what the experience of said snippets result in when chatting with the bot (kind of torn on that one)?!

It would be a decent way of getting across the quick aspect while highlighting the simplicity. Thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@wass3r @JordanSussman