Make a stem FAQ

added component::archived/stem easy owner::atagar priority::low resolution::implemented status::closed type::task website labels

Hi Sathyanarayanan. Actually, I've been compiling a list of questions over the last little while that might make for a nice FAQ. Switching this ticket over to be for that.

Trac:
Keywords: N/A deleted, website easy added
Summary: Document python versions supported by stem to Make a stem FAQ
Description: The website nor the wiki document which python versions are supported by stem.

to

We should include a FAQ within our docs. Some questions it might want to answer is...

What do our version numbers mean?
Summary of all of the modules (for developers), as a tree.
Python versions supported.
Does it work on python 3?
Does stem have any dependencies?

Trac:
Username: ashishnitinpatil
Cc: N/A to cool_asis_is@yahoo.in

Trac:
Username: ashishnitinpatil

Stem_FAQ.html

Stem FAQ with a decent HTML layout

Trac:
Username: ashishnitinpatil

The current FAQ is quite crude & may even be wrong in certain places. Please suggest required changes. #newbie

Trac:
Username: ashishnitinpatil
Status: new to needs_review

Hi Ashish. That is a nice start, though the FAQ should be part of the sphinx docs (that is to say, another section like 'https://stem.torproject.org/change_log.html'). While I see the appeal of copying content from various places like PyPI and the change log I'm not sure if that is really useful. An explanation of pip install, for instance, is more useful in the download section rather than a FAQ.

Cheers! -Damian

Trac:
Status: needs_review to needs_revision

Hmm... I did feel the need of standardising it under sphinx like you said. On it with the changes suggested! :)

Trac:
Username: ashishnitinpatil

We now have a FAQ. Feedback welcome!

https://stem.torproject.org/faq.html

Trac:
Status: needs_revision to closed
Resolution: N/A to implemented

closed

Make a stem FAQ

Child items ...

Activity