Documentation: Essentials

Current documentation can be found here: https://tools.cornerstonejs.org/

Essentials

This section is dedicated to teaching the essential information needed to use the cornerstone-tools library, and navigate common use cases/configurations without confusion. Current high level topics include:

• Getting Started
  • Desc: Minimum setup needed to setup/use cornerstone-tools
  • Claimed By: @dannyrb - 12/5/2017
• Input Sources
  • Desc: Mouse, touch, scrollwheel, etc.
  • Claimed By: @swederik - 12/19/2017
• Tool States
  • Desc: Rewrite of this wiki documentation
  • Claimed By: @dannyrb - 12/13/2017
• Image Tools
  • Desc: Overview of turning on/off one or more basic image tools (w/ demo)
  • Claimed By: Unclaimed
• Stack Tools
  • Desc: Overview of how to setup a stack, and use one or more basic stack tools (w/ demo)
  • Claimed By: @swederik - 01/22/2017
• Tool Data
  • Desc:
  • Claimed By: @dannyrb - 12/12/2017

Editing Docs

If you have a copy of the repository locally, the following command will generate a preview of docs w/ hot reloading for any changes you make:

npm run docs

• Source for docs can be found here
• Source for “essentials” can be found here

Create a PR against master, after doc changes are merged @swederik or myself can deploy them to https://tools.cornerstonejs.org

Discussion

• Are we missing any essential topics?
• Would you change anything about what I’ve listed above?
• Notify me that you’d like to claim a topic, and I’ll “reserve” it for you to write within the next 2-3 weeks

[swederik]

I’ll claim the input sources then.

[dannyrb]

Closing this. With vNext coming, its a bit outdated. It does raise questions around how to support docs for multiple versions, and provides an “okay” starting point for the revamped v3 docs. I’ve added it to the documentation project’s triage so we can use it to “jump start” new relevant issues.