Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
Updated readme of tr repository
  • Loading branch information
bhadley authored Jun 3, 2024
1 parent d26c8f9 commit 9bd8a68
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## What is this repository?
The wbcsd/tr repository, ‘tr’ standing for ‘technical report’, holds all document releases, especially of the Technical Specifications but not only.

## Goals of tr repository
The `tr` repository’s goals are:
* to act as a source of truth, enabling transparency and trustworthiness: community members can follow relevant updates by following this repository. Releases get a timestamp, changes from the version to version become visible for everyone. Changes to this repository cannot be made retrospectively, again turning this repository into a commitment to the community towards openness and transparency and transparent processes.

* to make releases referencable: By putting documents in this repository, they become accessible via the browser. Releases are important artefacts to community members that they rely on when developing solutions. Likewise, stable URLs become “citable” and fully referencable by others, for instance in policy documents, other standard-setting processes, etc.

**Limitations**

Since this repository is a collection of releases, it only includes `html` and `svg` files. All files used in the generation of these are kept solely in the `wbcsd/data-exchange-protocol` repo.


## Stable Links
For reference, this repository establishes the following stable links

Framework
* Latest version of framework: https://wbcsd.github.io/tr/framework/framework.pdf
* Framework v2: https://wbcsd.github.io/tr/2023/framework-20232601/framework.pdf

Tech Specs
* Latest version of tech specs: https://wbcsd.github.io/data-exchange-protocol/v2/

0 comments on commit 9bd8a68

Please sign in to comment.