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

Enough of a doc for someone unfamiliar to at least figure out what they don't get #7

Open
joeatwork opened this issue Apr 6, 2020 · 3 comments

Comments

@joeatwork
Copy link
Owner

Doc should include

  • Step by step "Do this, then this, then this" for a simple program
  • A description of the command language
  • Enough lore to be enjoyable
  • A victory condition for the reader
@Fauntleroy
Copy link

Will there be docs in the app itself? I'm super interested in tooltips or maybe some kind of quick reference on the side. Could even tie it directly into the game like an Obra Dinn menu ("SantaBot Reference Manual" or the like)

@joeatwork
Copy link
Owner Author

I'd like that! A possible future goal is a tutorial, with human-designed levels that demonstrate the commands. In the end, I'd like to make the written markdown doc obsolete (or maybe like you say, an in-app pure reference)

@joeatwork
Copy link
Owner Author

Joe don't close this until you have filed a follow-up bug with Tim's suggestion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants