Opened 4 years ago

Closed 4 years ago

#8577 closed task (implemented)

Make a stem FAQ

Reported by: gsathya Owned by: atagar
Priority: Low Milestone:
Component: Core Tor/Stem Version:
Severity: Keywords: website easy
Cc: cool_asis_is@… Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description (last modified by atagar)

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?

Child Tickets

Attachments (1)

Stem FAQ.html (5.5 KB) - added by ashishnitinpatil 4 years ago.
Stem FAQ with a decent HTML layout

Download all attachments as: .zip

Change History (7)

comment:1 Changed 4 years ago by atagar

  • Description modified (diff)
  • Keywords website easy added
  • Summary changed from Document python versions supported by stem to Make a stem FAQ

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.

comment:2 Changed 4 years ago by ashishnitinpatil

  • Cc cool_asis_is@… added

Changed 4 years ago by ashishnitinpatil

Stem FAQ with a decent HTML layout

comment:3 Changed 4 years ago by ashishnitinpatil

  • Status changed from new to needs_review

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

comment:4 Changed 4 years ago by atagar

  • Status changed from needs_review to needs_revision

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

comment:5 Changed 4 years ago by ashishnitinpatil

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

comment:6 Changed 4 years ago by atagar

  • Resolution set to implemented
  • Status changed from needs_revision to closed

We now have a FAQ. Feedback welcome!

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

Note: See TracTickets for help on using tickets.