Difference between revisions of "Documentation/Labs/DocumentationImprovments"

From Slicer Wiki
Jump to: navigation, search
Line 60: Line 60:
  
 
* [[New users]] page
 
* [[New users]] page
 +
 +
== Transition to a new platform ==
 +
 +
=== Expected features ===
 +
 +
* Analytics
 +
* Search
 +
* Easily editable by user with review process
 +
* Integrated with C++ and python documentation generator
 +
* hackable
 +
 +
=== Options ===
 +
 +
gitbook:
 +
 +
doxygen:
 +
 +
sphinx:
 +
 +
sphinx + readthedocs:
 +
 +
sphinx + readthedocs + doxygen:
 +
 +
mediawiki:

Revision as of 14:49, 22 June 2016

Home < Documentation < Labs < DocumentationImprovments

This page keeps track of possible improvement related to the Slicer documentation infrastructure.

Websites

slicer.org

  • Check.svg 2015-11-22 1967: Improve "slicer.org" page - Easier access to build / download / contribute

download.slicer.org

  • 1966: Add disclaimer associated with 32bit on download.slicer.org
  • Check.svg 2015-11-22 1991: Cosmetics for the slicer download page

Mediawiki: wiki.slicer.org

  1. Issue reports and feature requests can be listed using this link:
    http://tinyurl.com/zzssdfb

Infrastructure

  • 2971: Install MetaTags extension
    • Would be great to try it. Note that dependent extension StubManager is not maintained anymore
  • 1543: Install CategoryTree extension
  • 2190: Fix graphviz installation on Slicer wiki
  • 2170: Install extension SyntaxHighlight_GeSHi on Slicer wiki
  • Check.svg 2015-11-22 2272: Simplfy the first screen of the Slicer documentation page
  • 2968: Slicer wiki - Enable short url => easier configuration of robots.txt
  • Account
    • 4216: Wiki: Notify Slicer core developers
  • Analytics
    • 4215: Notify Slicer core developers when an account is created
  • Improved UI
    • 4214: Wiki: Add support for vectorial fonts

Improvements

User documentation

This page is being developed by Hillary from Queen University with help from Andras Lasso.

It is based on this mock-up and is intended to become the new Slicer landing page.

Transition to a new platform

Expected features

  • Analytics
  • Search
  • Easily editable by user with review process
  • Integrated with C++ and python documentation generator
  • hackable

Options

gitbook:

doxygen:

sphinx:

sphinx + readthedocs:

sphinx + readthedocs + doxygen:

mediawiki: