Feature #4616

Documentation refresh

Added by Mark Clarkstone about 1 year ago. Updated 18 days ago.

Status:NewStart date:2017-09-21
Priority:NormalDue date:
Assignee:Mark Clarkstone% Done:


Target version:4.4


I think the built-in help documentation for 4.4 could do with a good update.

My ideas:

  • Shorten the toc list, use a per page "Content" table?
  • Remove all "How to do xyz" sections per page (This is my fault).
  • Re-organise/merge some/all Help sections, e.g. "Introduction" - Overview, Features & Basic requirements could be one page. Ditto for the "Getting started" section (except for Configuring Tvheadend).
  • Have one page that simply explains how to use the web interface, including any gotchas & tips, dialog examples etc. This could include a smaller version of the current EPG overview page?
  • Remove all images & just have the property lists & their doc properties. Solely rely on the property docs?
  • A basic Howto section. This could include things like, how to setup users, blocking addresses, adding bouquets etc.
  • Make the wizard a lot smaller (text wise), use the Help button to open a doc on explaining the wizard setup instead.

Opinions / Additions folks?


#1 Updated by Mark Clarkstone 11 months ago

  • % Done changed from 0 to 80

See PR

#2 Updated by Pablo R. 18 days ago

Is this issue completed?

#3 Updated by Mark Clarkstone 18 days ago

Pablo R. wrote:

Is this issue completed?

Not fully no, help welcome!

Also available in: Atom PDF