Helpers\EditingGuide

Wiki Contribution Guidelines

Writing wiki pages is not less hard a job than writing codes. In fact, proper documentation is quite often the hardest among all software-related work, and is often crudely treated. The RooSight wiki uses a namespace-model to keep itself tidy and easy to track and navigate for new visitors. Here are a few facts about the namespace model for RooSight wiki:

• Modeled after C++'s namespaces
• Since GitHub doesn't provide hierarchies of pages, namespaces help separate one page from another and provide a hierarchy setup
• Namespaces are, basically, groups of pages under a common topic
• The top-level namespace is \. There are then a few second-level namespaces available:
  • \Home: Provides general introductions, announcements, guidelines, etc.
  • \Helpers: Stores housekeeping pages, such as templates for new, standard pages in different namespaces.
  • \Tutorial: The namespace for all the tutorials and hands-on introductions.
  • \Documentation: The namespace for the standard RooSight documentation.
  • \Guidelines: The namespace for storing usage guidelines
  • \CodeComments: More code and less usage demonstration as opposed to the \Documentation namespace

To-Do

We are yet to provide a cascade-like navigation menu here, under this page, for all entries to our wiki pages organized under different namespaces.