Merge pull request #6 from sine-fdn/raimundo/wording

feat: slight wording changes and small fixes

Author: raimundo-henriques

specs/index.bs

@@ -19,7 +19,7 @@ Boilerplate: omit conformance, omit copyright
 
 
 - Logistics emissions account for a significant share of global greenhouse gas emissions.
-- This document specifies a data model and [=data transactions=] necessary for the interoperable exchange of primary logistics emissions data
+- This document specifies a data model and [=data transactions=] necessary for the interoperable exchange of primary logistics emissions data.
 - The data model [[#data-model]] and the foundational data transactions ([[#txns]]) build upon the [[!GLEC]] Framework, the Pathfinder Framework, and the Pathfinder Technical Specifications.
 - By implementing this specification, different stakeholders of the logistics value chain can exchange data to enable logistics emissions calculation for [=shipments=].
 - This technical specification is based on the [[!GLEC]] Framework, the related [[!ISO14083|ISO 14083]], and the Data Exchange Project of [=SFC=].
@@ -126,7 +126,7 @@ Advisement: The current technical specifications are undergoing continuous refin
 :: A party that is offering transport services
 
 : <dfn>Host System</dfn>
-:: See Pathfinder Tech Specs for the definition.
+:: See [Pathfinder Tech Specs](https://wbcsd.github.io/tr/2023/data-exchange-protocol-20231207/#host-system) for the definition.
     Here, a host system additionally implements support for 1 or more data transactions ([[#txns]]).
 
 : <dfn>ShipmentFootprint</dfn>
@@ -280,7 +280,7 @@ The [=Transport Service Organizer=] or a [=Transport Service User=] CAN then ret
 
 # End-to-End Example # {#example}
 
-Note: non-normative section
+Note: Non-normative section
 
 This section provides an end-to-end example of how the data transactions ([[#txns]])
 enable logistics emissions transparency for a single shipment.
@@ -353,15 +353,15 @@ For this, the Transport Service Organizer `Z` performs the following data transa
 After Transport Service Organizer `Z` has performed its data collection, the Transport Service User `S`
 can calculate the logistics emissions of the shipment by
 
-1. collecting the <{TCE|TCEs}> from `S` using the [=shipment id=] and [[#txn1]], storing the resulting <{TCE|TCEs}> in e.g. its database
+1. collecting the <{TCE|TCEs}> from `S` using the [=shipment id=] and [[#txn1]], storing the resulting <{TCE|TCEs}> in e.g. its database.
 1. `S` can further verify the <{TCE|TCEs}> by collecting the <{TOC|TOCs}> from `Z` using [[#txn2]]
-2. To compute the logistics emissions, `Z` can form the [=TC=] from the collected <{TCE|TCEs}> by taking the <{TCE|TCEs}> of step 1 and
+1. To compute the logistics emissions, `Z` can form the [=TC=] from the collected <{TCE|TCEs}> by taking the <{TCE|TCEs}> of step 1 and
     by calculating the logistics emissions for this shipment by following the [[!GLEC]] Framework and ISO 14083.
 
 
 ## Example HTTP Calls ## {#example-http}
 
-### Data Collection by `Z` ### {#example-http-z}
+### Data Collection by Transport Service Organizer `Z` ### {#example-http-z}
 
 To collect the <{TCE|TCEs}> from Carrier `A`, `Z` performs the following HTTP call.
 
@@ -372,7 +372,7 @@ Note: The call to `/footprints` can return several footprints, 1 for each shipme
 The highlighted lines show the data exchanged according to the <{ShipmentFootprint}> data model.
 
 <div class=example>
-  Example HTTP Request (cURL) to collect TCE Data from Carrier A:
+  Example HTTP Request (cURL) to collect TCE Data from Carrier A (please note that an actual API call would require authentication):
   <pre highlight='sh'>
       curl -X 'GET' \
       'https://api.transport-operator-a.com/2/footprints'
@@ -408,7 +408,7 @@ The highlighted lines show the data exchanged according to the <{ShipmentFootpri
         "referencePeriodStart": "2021-01-01T00:00:00Z",
         "referencePeriodEnd": "2022-01-01T00:00:00Z",
         "secondaryEmissionFactorSources": [ { "name": "Ecoinvent", "version": "3.9.1" } ],
-        "exemptedEmissionsPercent": "0.0",
+        "exemptedEmissionsPercent": 0.0,
         "exemptedEmissionsDescription": "",
         "packagingEmissionsIncluded": true,
         "primaryDataShare": 100.0
@@ -442,7 +442,7 @@ The highlighted lines show the data exchanged according to the <{ShipmentFootpri
 </div>
 
 
-### Data Collection by `S` ### {#example-http-s}
+### Data Collection by Transport Service User `S` ### {#example-http-s}
 
 To collect the TCEs related to the shipment and organizer `Z`, `S` performs the following HTTP call which yields 2 TCEs.
 
@@ -453,7 +453,7 @@ Note: The call to `/footprints` can return several footprints, 1 for each shipme
 The highlighted lines show 2 TCEs which `Z` has collected and calculated for `S`.
 
 <div class=example>
-  Example HTTP Request (cURL) to collect TCE Data:
+  Example HTTP Request (cURL) to collect TCE Data (please note that an actual API call would require authentication):
   <pre highlight='sh'>
       curl -X 'GET' \
       'https://api.transport-organizer.com/2/footprints'