diff --git a/docs/accordproject-template.md b/docs/accordproject-template.md index 38cf972..1af8004 100644 --- a/docs/accordproject-template.md +++ b/docs/accordproject-template.md @@ -205,7 +205,7 @@ Let's look at each component of the template triangle, starting with the text. ### What next? -Build your first smart legal contract templates, either [online](tutorial-latedelivery.md) with Template Studio, or by [installing Cicero](started-installation.md). +Build your first smart legal contract templates, either [online](tutorial-studio.md) with Template Studio, or by [installing Cicero](started-installation.md). Explore [sample templates](started-resources.md) and other resources in the rest of this documentation. diff --git a/docs/ergo-tutorial.md b/docs/ergo-tutorial.md index 7021316..0bccd3f 100644 --- a/docs/ergo-tutorial.md +++ b/docs/ergo-tutorial.md @@ -39,7 +39,7 @@ Before you can build Ergo, you must install and configure the following dependen ### Git -* Git: The [Github Guide to Installing Git][git-setup] is a good source of information. +* Git: The [Github Guide to Installing Git][git-setup.md] is a good source of information. ### Node.js diff --git a/docs/logic-advanced-expr.md b/docs/logic-advanced-expr.md index a4ee782..0230af3 100644 --- a/docs/logic-advanced-expr.md +++ b/docs/logic-advanced-expr.md @@ -74,7 +74,7 @@ and should return the array `[{a: 3.0, b: 4.0, c: 5.0}, {a: 4.0, b: 3.0, c: 5.0} ## Template Literals -Template literals are similar to [String literals](logic-simple-expr#literal-values) but with the ability to embed Ergo expressions. They are written with between `` ` `` and may contains Ergo expressions inside `{{%` and `%}}`. +Template literals are similar to [String literals](logic-simple-expr.md#literal-values) but with the ability to embed Ergo expressions. They are written with between `` ` `` and may contains Ergo expressions inside `{{%` and `%}}`. The following Ergo expressions illustrates the use of a template literal to construct a String describing the content of a record. ``` @@ -88,7 +88,7 @@ Should return the string literal `"Course \"Law for developers\" (Cost: 29.99)"` ## Formatting -One can use template formatting using the `Expr as "FORMAT"` Ergo expression. Supported formats are the same as those available in TemplateMark [Formatted Variables](markup-templatemark#formatted-variables). +One can use template formatting using the `Expr as "FORMAT"` Ergo expression. Supported formats are the same as those available in TemplateMark [Formatted Variables](markup-templatemark.md#formatted-variables). For instance: ``` diff --git a/docs/logic-complex-type.md b/docs/logic-complex-type.md index 77f405f..7e993e4 100644 --- a/docs/logic-complex-type.md +++ b/docs/logic-complex-type.md @@ -30,7 +30,7 @@ You can construct arrays using other expressions: [pi,e,golden] ``` -Ergo also provides functions to manipulate arrays as parts of its [standard library](ref-logic-stdlib.md#functions-on-arrays). The following example uses the `sum` function to calculate the sum of all the elements in the `prettynumbers` array. +Ergo also provides functions to manipulate arrays as parts of its [standard library](ref-ergo-stdlib.md#functions-on-arrays). The following example uses the `sum` function to calculate the sum of all the elements in the `prettynumbers` array. ```ergo let pi = 3.14; let e = 2.72; @@ -49,7 +49,7 @@ You can access the element at a given position inside the array using an index: fruits[4] // Returns: none ``` - Note that the index starts at `0` for the first element and that indexed-based access returns an optional value, since Ergo compiler cannot statically determine whether there will be an element at the corresponding index. You can learn more about how to handle optional values and types in the [Optionals](logic-complex-type#optionals) Section below. + Note that the index starts at `0` for the first element and that indexed-based access returns an optional value, since Ergo compiler cannot statically determine whether there will be an element at the corresponding index. You can learn more about how to handle optional values and types in the [Optionals](logic-complex-type.md#optionals) Section below. ## Classes @@ -181,7 +181,7 @@ else "I found nothing :-(" ``` and should return `"I found nothing :-("`. -More details on match expressions can be found in [Advanced Expressions](logic-advanced-expr#match). +More details on match expressions can be found in [Advanced Expressions](logic-advanced-expr.md#match). For conciseness, a few operators are also available on optional values. One can give a default value when the optional is `none` using the operator `??`. For instance: diff --git a/docs/logic-ergo.md b/docs/logic-ergo.md index a027496..d7122b6 100644 --- a/docs/logic-ergo.md +++ b/docs/logic-ergo.md @@ -12,7 +12,7 @@ Ergo aims to: - ensure safe execution: the language should prevent run-time errors and non-terminating logic - be blockchain neutral: the same contract logic can be executed either on and off chain on a variety of distributed ledger technologies - be formally specified: the meaning of contracts should be well defined so it can be verified, and preserved during execution -- be consistent with the [Accord Project Templates](accordproject-template) +- be consistent with the [Accord Project Templates](accordproject-template.md) ## Design Choices diff --git a/docs/logic-simple-type.md b/docs/logic-simple-type.md index 6579b84..fb7577b 100644 --- a/docs/logic-simple-type.md +++ b/docs/logic-simple-type.md @@ -13,7 +13,7 @@ the comments mention that `"John Smith"` is of type `String`, and that `1` is of In reality, the Ergo compiler understands which types your expressions have and can detect whether those expressions apply to the right type(s) or not. -Ergo types are based on the [Concerto Modeling](model-concerto) Language. +Ergo types are based on the [Concerto Modeling](model-concerto.md) Language. ## Primitive types diff --git a/docs/markup-preliminaries.md b/docs/markup-preliminaries.md index f1af180..cf51072 100644 --- a/docs/markup-preliminaries.md +++ b/docs/markup-preliminaries.md @@ -9,7 +9,7 @@ The text for Accord Project templates is written using markdown. It builds on th As with other markup languages, CommonMark can express the document structure (e.g., headings, paragraphs, lists) and formatting useful for readability (e.g., italics, bold, quotations). -The main reference is the [CommonMark Specification](https://spec.commonmark.org/0.29/) but you can find an overview of CommonMark main features in the [CommonMark](markup-commonmark) Section of this guide. +The main reference is the [CommonMark Specification](https://spec.commonmark.org/0.29/) but you can find an overview of CommonMark main features in the [CommonMark](markup-commonmark.md) Section of this guide. ## Accord Project Extensions @@ -69,7 +69,7 @@ and monthly payments of {{%£667.00%}} {{/clause}} ``` -More information and examples can be found in the [CiceroMark](markup-ciceromark) part of this guide. +More information and examples can be found in the [CiceroMark](markup-ciceromark.md) part of this guide. ### TemplateMark @@ -95,7 +95,7 @@ and monthly payments of {{% monthlyPaymentFormula(loanAmount,rate,loanDuration) {{/clause}} ``` -More information and examples can be found in the [TemplateMark](markup-templatemark) part of this guide. +More information and examples can be found in the [TemplateMark](markup-templatemark.md) part of this guide. ## Dingus diff --git a/docs/markup-templatemark.md b/docs/markup-templatemark.md index 8085d73..329322f 100644 --- a/docs/markup-templatemark.md +++ b/docs/markup-templatemark.md @@ -5,7 +5,7 @@ title: TemplateMark TemplateMark is an extension to CommonMark used to write the text in Accord Project templates. The extension includes new markdown for variables, inline and container elements of the markdown and template formulas. -The kind of extension which can be used is based on the _type_ of the variable in the [Concerto Model](model-concerto) for your template. For each type in your model differrent markdown elements apply: variable markdown for atomic types in the model, list blocks for array types in the model, optional blocks for optional types in the model, etc. +The kind of extension which can be used is based on the _type_ of the variable in the [Concerto Model](model-concerto.md) for your template. For each type in your model differrent markdown elements apply: variable markdown for atomic types in the model, list blocks for array types in the model, optional blocks for optional types in the model, etc. ## Variables diff --git a/docs/ref-migrate-0.13-0.20.md b/docs/ref-migrate-0.13-0.20.md index 930439e..e7b982d 100644 --- a/docs/ref-migrate-0.13-0.20.md +++ b/docs/ref-migrate-0.13-0.20.md @@ -6,7 +6,7 @@ title: Cicero 0.13 to 0.20 Much has changed in the `0.20` release. This guide provides step-by-step instructions to port your Accord Project templates from version `0.13` or earlier to version `0.20`. :::note -Before following those migration instructions, make sure to first install version `0.20` of Cicero, as described in the [Install Cicero](started-installation) Section of this documentation. +Before following those migration instructions, make sure to first install version `0.20` of Cicero, as described in the [Install Cicero](started-installation.md) Section of this documentation. ::: ## Metadata Changes diff --git a/docs/ref-migrate-0.20-0.21.md b/docs/ref-migrate-0.20-0.21.md index 0914a1c..fd3d9a5 100644 --- a/docs/ref-migrate-0.20-0.21.md +++ b/docs/ref-migrate-0.20-0.21.md @@ -6,7 +6,7 @@ title: Cicero 0.20 to 0.21 The main change between the `0.20` release and the `0.21` release is the new markdown syntax and parser infrastructure based on [`markdown-it`](https://github.com/markdown-it/markdown-it). While most templates designed for `0.20` should still work on `0.21` some changes might be needed to the contract or template text to account for this new syntax. :::note -Before following those migration instructions, make sure to first install version `0.21` of Cicero, as described in the [Install Cicero](started-installation) Section of this documentation. +Before following those migration instructions, make sure to first install version `0.21` of Cicero, as described in the [Install Cicero](started-installation.md) Section of this documentation. ::: ## Metadata Changes diff --git a/docs/ref-migrate-0.21-0.22.md b/docs/ref-migrate-0.21-0.22.md index c882458..56b1c57 100644 --- a/docs/ref-migrate-0.21-0.22.md +++ b/docs/ref-migrate-0.21-0.22.md @@ -6,7 +6,7 @@ title: Cicero 0.21 to 0.22 The main change between the `0.21` release and the `0.22` release is the switch to version `1.0` of the Concerto modeling language and library. This change comes along with a complete revision for the Accord Project "base models" which define key types for: clause and contract data, parties, obligations and requests / responses. We encourage developers to get familiarized with the [new base models](https://github.com/accordproject/models/tree/master/src/accordproject) before switching to Cicero `0.22`. :::note -Before following those migration instructions, make sure to first install version `0.22` of Cicero, as described in the [Install Cicero](started-installation) Section of this documentation. +Before following those migration instructions, make sure to first install version `0.22` of Cicero, as described in the [Install Cicero](started-installation.md) Section of this documentation. ::: ## Metadata Changes diff --git a/docs/ref-web-components-overview.md b/docs/ref-web-components-overview.md index f0a7c3a..004d2e4 100644 --- a/docs/ref-web-components-overview.md +++ b/docs/ref-web-components-overview.md @@ -18,7 +18,7 @@ The Contract Editor component provides a rich-text content editor for contract t The contract editor does not support templates which use the following CiceroMark features: * Lists containing [nested lists](markup-commonmark.md#nested-lists) -* Templates [list blocks](markup-blocks.md#list-blocks) +* List blocks [list blocks](markup-commonmark.md#list-blocks) ## Error Logger