search

shapeshifter / shapeshifter-specification

This repository contains the Shapeshifter specification. Files in this repository are used to generate an easily readable and navigable specification, that can be accessed using the link below
https://shapeshifter.github.io/shapeshifter-specification/
Apache License 2.0
6 stars 8 forks source link

Metering documentation #59

Closed Edward-Ross-Gridimp closed 1 year ago

RobbenRiksen commented 2 years ago

The added text, metering and meteringResponse messages and contractId and ServiceType fields are looking good plus I am able to open the file in word again!

One comment is that in step 2 of the settle phase the 'DNO' is mentioned. This is the only place in the document that mentiones DNO (except for the glossary) so if this is equivalent to 'DSO' I would suggest using DSO here and removing DNO from the glossary.

Second thing: Many things appear to be broken. E.g. broken links to other places in the document (e.g. on page 12 'see section 4.2.10()'), a broken footnote on page 12 (!!br0ken!!), and many use case diagrams e.g. 3-14, 3-16,, 3-17, 3-18, 3-20, 3-22. image

Are these caused by these commits? Or are these issues that need to be addressed separately?

Edward-Ross-Gridimp commented 2 years ago

I have reapplied the changes using LibreOffice V7.3.6.2 and saved as word format.

The diagram in section 3.7.3 was rotated before I made the changes, so remains rotated, but legible.

Edward-Ross-Gridimp commented 1 year ago

Changes already merged into main.