Skip to content

Commit

Permalink
docs/guidance/example.md: Add links to field anchors
Browse files Browse the repository at this point in the history
  • Loading branch information
duncandewhurst committed Mar 23, 2023
1 parent 55a2848 commit 22529f1
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/guidance/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ This page provides examples to help you understand and implement OC4IDS. There a

## Worked example

The worked example is a JSON file that conforms to the [project package schema](../../reference/package). It contains a single project that conforms to the [project schema](../../reference/schema). You can view the complete worked example below or [download the JSON file](../examples/example.json). You can also view excerpts from the worked example alongside each sub-schema in the [schema reference documentation](../../reference/schema).
The worked example is a JSON file that conforms to the [project package schema](../reference/package). It contains a single project that conforms to the [project schema](../reference/schema). You can view the complete worked example below or [download the JSON file](../examples/example.json). You can also view excerpts from the worked example alongside each sub-schema in the [schema reference documentation](../reference/schema).

The worked example describes a fictional infrastructure project to upgrade a motorway in the UK with three related contracting processes. An example value is provided for each field in the schema, including:

* [`forecasts`](../../reference/schema/) and [`metrics`](../../reference/schema) that describe planned and actual physical progress
* [`modifications`](../../reference/schema/) that describe changes to the duration, scope and value of contracting processes
* [`completion`](../../reference/schema/) data, describing the final end date, value and scope of the project.
* [`forecasts`](../reference/schema.md#project-schema.json,,forecasts) and [`metrics`](../reference/schema.md#project-schema.json,,metrics) that describe planned and actual physical progress
* [`modifications`](../reference/schema.md#project-schema.json,,metrics) that describe changes to the duration, scope and value of contracting processes
* [`completion`](../reference/schema.md#project-schema.json,,completion) data, describing the final end date, value and scope of the project.

```{jsoninclude} ../../docs/examples/example.json
:jsonpointer:
Expand All @@ -19,7 +19,7 @@ The worked example describes a fictional infrastructure project to upgrade a mot

## Blank example

The blank example is a JSON file that conforms to the structure of the [project schema](../../reference/schema). You can view the blank example below or [download the JSON file](../examples/blank.json). Field values are replaced with either:
The blank example is a JSON file that conforms to the structure of the [project schema](../reference/schema). You can view the blank example below or [download the JSON file](../examples/blank.json). Field values are replaced with either:

* Empty strings (`""`) or empty arrays (`[]`)
* The type of the field, e.g. "string" or "array"
Expand Down

0 comments on commit 22529f1

Please sign in to comment.