dcmqi icon indicating copy to clipboard operation
dcmqi copied to clipboard

gitbook documentation improvements and reorganization

Open fedorov opened this issue 8 years ago • 3 comments

This is the place to discuss overall suggestions for improving documentation:

Feedback from @pieper:

  • [ ] My biggest comment is that it needs a "TL;DR" (or Quick Start) that gets right to the point and includes links to the other sections for detail.
  • [ ] Another useful section would probably really help people is a few brief examples. [ single conversion task, batch conversion ]

Other ideas:

  • [x] consider moving gitbook into a separate repository?
  • [x] look at this (and other) gitbooks/documentation examples for organization layout http://redux.js.org/#

fedorov avatar Jan 28 '17 17:01 fedorov

Moving gitbook to a separate repository makes absolutely sense to me. Especially removing the source code from the gitbook branch/repository

che85 avatar Jan 28 '17 18:01 che85

@che85 another approach could be to merge documentation with master, switch to using desktop editor all the time, and in this way keep commits meaningful. You can look at this project - they keep their gitbook in the master: https://github.com/reactjs/redux

fedorov avatar Jan 28 '17 18:01 fedorov

Ok guys - you convinced me, I will move it into a separate repo.

fedorov avatar Jan 28 '17 21:01 fedorov