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

Add more screen-caps of interesting examples using http://showterm.io ? #25

Open
tbielawa opened this issue Jun 8, 2015 · 1 comment

Comments

@tbielawa
Copy link
Collaborator

tbielawa commented Jun 8, 2015

Just experimented around with this in http://juicer.readthedocs.org/en/latest/contributing.html#running-the-tests where we demonstrate to users how to run the built-in test suite. I replaced the original static-output with a capture ("cap") I made on http://showterm.io

It's nice -- No questions about it. However, we need to discuss the balance between static examples and flashier ones like this.

When we're deciding if an example deserves a cap we may want to include these items in our discussion:

  • Is it equally informative and useful if we just use a static text output?
  • What value is added by including a showterm.io capture?

Longer-term thinking here:

  • A test on my galaxy s6 showed that we can embed these screen caps in RTDs without any issues. That takes care of actually inserting them into our site documentation and limited mobile platform testing.
  • What about "dumb" browsers. Or people who just want simple static text documentation? Speaking for myself I tend to cringe when people only provide youtube "documentation" or examples. I hate hate hate listening to videos. 99% of the time I wish there was just a plain text example.

Ideas considered over phone:

  • A fancy jquery-type fixture to allow users to select (perhaps from a content box with tabs) which example type they would prefer to see
  • Simply including both the static text examples and the showterm.io flashy hotness
@tbielawa
Copy link
Collaborator Author

tbielawa commented Jun 9, 2015

Fun fact. I wrote (modified an existing) sphinx extension to provide support for a new .. showterm:: <ID> directive. See an example on the contributing.rst page. Super simple.

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

No branches or pull requests

1 participant