Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation #20

Open
5 of 6 tasks
johndgiese opened this issue Feb 26, 2020 · 1 comment
Open
5 of 6 tasks

Improve Documentation #20

johndgiese opened this issue Feb 26, 2020 · 1 comment
Assignees
Milestone

Comments

@johndgiese
Copy link
Contributor

johndgiese commented Feb 26, 2020

  • Add an "Installation" section; we can install using pip install dicom-standard. Also include the curl or wget commands needed to pull down either the latest version of the JSON or a particular pinned version.
  • Add a section which describes our philosophy for the format of the JSON files; in particular, that it is likely that the JSON will need to get massaged for other use-cases. Mention that this was originally for our DICOM standard browser (and link to it). Then discuss how our philosophy has changed to be more general. See Add "id" property to JSON files to act as a foreign key #24 (comment) for a good starting place!
  • Take a pass through the existing sections and clean them up; prune them out as much as possible
  • Discuss how we handle issues with the DICOM standard
  • Discuss how often/when we update the JSON files
  • Explain how we handle functional group macros, and why they are a weird exception. Maybe we could include it in a list of the processing steps we handle on behalf of users of the library, along with expanding macros and the various DICOM standard inconsistencies we correct for.
@johndgiese johndgiese added this to the v1.0 milestone Feb 26, 2020
@johndgiese
Copy link
Contributor Author

We should include a nice diagram of the relational model of the JSON files (e.g., like we do for most of our application database schema discussions).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants