bruderol
commented
8 years ago I improved and partialy completed the documentation.
I consider following sections as finalized:
- Intro: https://github.com/scenarioo/scenarioo-format/blob/master/format.md#scenarioo-format-specification
- Model Overview: https://github.com/scenarioo/scenarioo-format/blob/master/format.md#domain-model-overview
- File System Structure: https://github.com/scenarioo/scenarioo-format/blob/master/format.md#file-system-structure
- Reference Example: https://github.com/scenarioo/scenarioo-format/blob/master/format.md#reference-example
- Branch Entity Description: https://github.com/scenarioo/scenarioo-format/blob/master/format.md#branch
- Data Types: https://github.com/scenarioo/scenarioo-format/blob/master/format.md#data-types
- More detailed docu about Scenarioo DocuObject Model: https://github.com/scenarioo/scenarioo-format/blob/master/scenarioo_object_model.md
- Reference Example: https://github.com/scenarioo/scenarioo-format/tree/master/reference-example
What is missing or not yet finalized:
- other sections in "Entities and their fields" (only "Branch" is currently complete and aligned with new format)
- "Migration Guide" not yet complete
- add some pictures to demonstrate how which data, especially
labels,page,sections,propertiesandDocuObjectof different types get visualized in the viewer.
@tobiaszuercher @dola @adiherzog Could you review the finalized sections and give some feedback. I hope that is good enough and understandable? I will try to finalize the other missing sections accordingly soon.
Especially I recommend to review the new overview pictures
Finalize format documentation for all fields.
See all open points in #2 and then document it cleanly.