Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Register
  • Sign in
  • W webViz
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 3
    • Issues 3
    • List
    • Boards
    • Service Desk
    • Milestones
  • Deployments
    • Deployments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • Repository
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • Social Cognitive SystemsSocial Cognitive Systems
  • webViz
  • Issues
  • #2
Closed
Open
Issue created Nov 22, 2018 by Jan Pöppel@jpoeppelOwner

Improve documentation

If the tool should be used going forward, it should be documented appropriately. The readme should at the very least include:

  • Descriptions of all components
    • This includes description of available configuration and made assumptions regarding data structure
  • Improved/more suitable example images once the tool has become more finalized in its appearance.
  • A basic example of how to add new components
    • This needs to include information about how the config Information needs to be structured
  • Some reference to how the communication with the redux store works.
    • This should include how the store is organized.
Edited Nov 22, 2018 by Jan Pöppel
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
Time tracking