Updated Introduction > Key Concepts #209
Conversation
Signed-off-by: Katie <[email protected]>
docs/accordproject-concepts.md
Outdated
| - **The Template Logic**: the executable business logic for the template | ||
|
|
||
|  | ||
|
|
||
| When combined these three elements allow templates to be edited, validated, verified, and then executed on any computer platform (on your own machine, on a Cloud platform, on Blockchain, etc). | ||
| The three components (Text - Model - Logic) can also be intuitively understood as a **linear progression**, from _human-readable_ legal text to _machine-readable_ code. When combined these three elements allow templates to be edited, validated, verified, and then executed on any computer platform (on your own machine, on a Cloud platform, on Blockchain, etc). |
There was a problem hiding this comment.
The mathematician in me is shaking its head. How about progression or incremental progression?
There was a problem hiding this comment.
Hahaha sounds good ;) (makes note to self - nothing with linear next time...)
There was a problem hiding this comment.
Hahaha sounds good ;) (makes note to self - nothing with linear next time...)
Well I could suggest to use linear when it's actually linear ! 😉
docs/accordproject-concepts.md
Outdated
|
|
||
| That logic specify what conditions should be met for a delivery to be accepted (checking whether the delivery is timely or not, has a mandatory inspection for that delivery occurred or not, etc). | ||
| The above logic specify what conditions should be met for a delivery to be accepted. The code above checks whether delivery has already been made; whether the acceptance is timely, within the specified inspection date; and whether the inspection has passed or not. |
Signed-off-by: Katie <[email protected]>
Signed-off-by: Katie <[email protected]>
docs/accordproject-developers.md
Outdated
|
|
||
| If you are new to the Accord Project, please read the [Key Concepts](accordproject-concepts) page. This will allow you to understand the three components of a template (text, model, and logic) and how they work together. | ||
|
|
||
| If you want to create a template yourself, please see the [Legal-Tech Tutorials - Authoring in Template Studio](tutorial-latedelivery) page for a step-by-step guide on how to create your first template on template studio. If you want to author, validate, and run Accord Project templates _locally_, please visit our [Install Cicero](https://docs.accordproject.org/docs/next/started-installation.html) page for instructions. |
There was a problem hiding this comment.
I would split this part three paragraphs:
- a paragraph pointing to the getting started guide (same link) to quickly get up and running as a developer
- the additional information for legal tech and
- the
dive into our technology stackpart as is
docs/accordproject-concepts.md
Outdated
| } | ||
| ``` | ||
|
|
||
| Thanks to the model, the computer now knows that the `shipper` variable (`"Party A"` in the example above) and the `receiver` variable (`"Party B"` in the example above) are both `Organization` types; that variable `businessDays` (`10` in the example above) is an `Integer` type; and that variable `deliverable` (`"Widgets"` in the example above) is a `String` type, and can contain any text description. |
There was a problem hiding this comment.
Avoid "above"
Also could make a reference to the Concerto section coming after, because this feels like it may be separate from the next section, and I may be left confused at what an "Organization type" is, etc.
I'll make note here about the next section, I think "for" should be behind the colon, and that list should either be a bulleted list or there shouldn't be a colon. And "Section" in "... the Concerto Modeling Section ..." doesn't need to be capitalized.
|
Added a bunch of comments, this is looking so good @4katie! |
Signed-off-by: Katie <[email protected]>
|
Hi @irmerk and @jeromesimeon, thanks for such quick & helpful feedback! I think I made all of the changes requested except for:
Any comments / feedback / suggestions would be super helpful! :D |
Signed-off-by: Katie [email protected]
Issue #111
Introduction > Key ConceptsIntroduction > For BusinessChanges
Introduction > Key Conceptsby elaborating on some of the conceptsFlags
For the
modelcode block, thectolanguage is currently undefined, so I usedergoinstead. Works perfectly fine, but may want to update this when concerto is supported in the future.Related Issues