diff --git a/404.html b/404.html index 9124f512f..292054036 100644 --- a/404.html +++ b/404.html @@ -1,5 +1,5 @@ -Lost? Don't worry -
-RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
Lost?
Error 404
Seems like what you are looking for can't be found. Don't worry, we can bring you back to the homepage.
\ No newline at end of file +Lost? Don't worry +
+RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
Lost?
Error 404
Seems like what you are looking for can't be found. Don't worry, we can bring you back to the homepage.
\ No newline at end of file diff --git a/concepts/adaptor/index.html b/concepts/adaptor/index.html index b1a8eb35c..10a634e30 100644 --- a/concepts/adaptor/index.html +++ b/concepts/adaptor/index.html @@ -1,8 +1,8 @@ -Adaptor | RIDDL DocumentationAdaptor | RIDDL Documentation + -
+Message Translation Adaptors do their work at the level of messages sent between Contexts.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/application/index.html b/concepts/application/index.html index b45e25337..0fed39adc 100644 --- a/concepts/application/index.html +++ b/concepts/application/index.html @@ -1,5 +1,5 @@ -Application | RIDDL Documentation -
+Application | RIDDL Documentation +
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/author/index.html b/concepts/author/index.html index 442e27f25..91a52eccf 100644 --- a/concepts/author/index.html +++ b/concepts/author/index.html @@ -1,11 +1,11 @@ -Author | RIDDL DocumentationAuthor | RIDDL Documentation + -
+Contains No other definitions">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +

No other definitions

\ No newline at end of file diff --git a/concepts/case/index.html b/concepts/case/index.html index 19951e3f2..cb204a521 100644 --- a/concepts/case/index.html +++ b/concepts/case/index.html @@ -1,8 +1,8 @@ -Story Case | RIDDL DocumentationStory Case | RIDDL Documentation + -
+A case is composed of a set of steps. Those steps consist of a described relationship between two components. These can be general (any component to any component) or specific for certain pairs of components.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/conditional/index.html b/concepts/conditional/index.html index 9a60ad17f..0369bd9a8 100644 --- a/concepts/conditional/index.html +++ b/concepts/conditional/index.html @@ -1,14 +1,14 @@ -Condition | RIDDL DocumentationCondition | RIDDL Documentation + -
+Occurs In Statements Contains Nothing">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

TBD

Conditions (Boolean Expressions)

TBD

Occurs In

Contains -

Nothing

\ No newline at end of file +

Nothing

\ No newline at end of file diff --git a/concepts/constant/index.html b/concepts/constant/index.html index 1bdbc35e7..db19a02c4 100644 --- a/concepts/constant/index.html +++ b/concepts/constant/index.html @@ -1,11 +1,11 @@ -Constant | RIDDL DocumentationConstant | RIDDL Documentation + -
+Adaptors, Applications, Contexts, Domains, Functions, Entities, Epic. Processors, Projectors, Repositories Sagas, and Contains Nothing">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

Constant

A constant is simply a definition that names an unchanging value. This is useful for modeling technical domains that utilize constant values

Occurs In

All vital{{ < relref “vital.md” >}} definitions may contain constants.

Contains -

Nothing

\ No newline at end of file +

Nothing

\ No newline at end of file diff --git a/concepts/context/index.html b/concepts/context/index.html index 8a9c664e0..d49af190e 100644 --- a/concepts/context/index.html +++ b/concepts/context/index.html @@ -1,5 +1,5 @@ -Context | RIDDL Documentation -
+Context | RIDDL Documentation +
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/definition/index.html b/concepts/definition/index.html index 9c55e0697..896e23e57 100644 --- a/concepts/definition/index.html +++ b/concepts/definition/index.html @@ -1,11 +1,11 @@ -Definition | RIDDL DocumentationDefinition | RIDDL Documentation + -
+loc: The location of the definition in its input file.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +are informational rather than definitional.

\ No newline at end of file diff --git a/concepts/description/index.html b/concepts/description/index.html index 74e16192e..d7f90f2bf 100644 --- a/concepts/description/index.html +++ b/concepts/description/index.html @@ -1,11 +1,11 @@ -Description | RIDDL DocumentationDescription | RIDDL Documentation + -
+Contains Markdown text either directly in RIDDL, in a file, or via a URL.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +

Markdown text either directly in RIDDL, in a file, or via a URL.

\ No newline at end of file diff --git a/concepts/domain/index.html b/concepts/domain/index.html index f9a24821b..ee398039e 100644 --- a/concepts/domain/index.html +++ b/concepts/domain/index.html @@ -1,5 +1,5 @@ -Domain | RIDDL Documentation -
+Domain | RIDDL Documentation +
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

Contains -

Within a domain, you can define these things:

Within a domain, you can define these things:

\ No newline at end of file +the domain
\ No newline at end of file diff --git a/concepts/element/index.html b/concepts/element/index.html index 85edc56e9..3ae1f8c4c 100644 --- a/concepts/element/index.html +++ b/concepts/element/index.html @@ -1,11 +1,11 @@ -Application Element | RIDDL DocumentationApplication Element | RIDDL Documentation + -
+UI Element RIDDL Description Input Give input of data items to fill an aggregate Input Select select item(s) from a list Output View presents a data value for consideration Navigation Activate cause the application to change its context Container Group groups elements together Activate An Activate definition instructs the application to change context to a different group of elements.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

An Activate definition instructs the application to change context to a different group of elements.

Occurs In

Contains -

  1. See Critical UI Elements of Remarkable Interfaces ↩︎

\ No newline at end of file +

  1. See Critical UI Elements of Remarkable Interfaces ↩︎

\ No newline at end of file diff --git a/concepts/entity/index.html b/concepts/entity/index.html index 12e78de17..3d90691ed 100644 --- a/concepts/entity/index.html +++ b/concepts/entity/index.html @@ -1,10 +1,11 @@ -Entity | RIDDL DocumentationEntity | RIDDL Documentation + -
+Entities in the software implementation of the model are objects, containing both state and function.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +the entity
\ No newline at end of file diff --git a/concepts/epic/index.html b/concepts/epic/index.html index 089308a92..04056a4a7 100644 --- a/concepts/epic/index.html +++ b/concepts/epic/index.html @@ -1,14 +1,14 @@ -Epics | RIDDL DocumentationEpics | RIDDL Documentation + -
+In order to receive {benefit}, as an {user}, I can {capability}">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/field/index.html b/concepts/field/index.html index 437192cde..09fe8996c 100644 --- a/concepts/field/index.html +++ b/concepts/field/index.html @@ -1,14 +1,14 @@ -Field | RIDDL DocumentationField | RIDDL Documentation + -
+Occurs In Types States Projectors Contains Nothing">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +

Nothing

\ No newline at end of file diff --git a/concepts/function/index.html b/concepts/function/index.html index ef59c0c4e..b621c1724 100644 --- a/concepts/function/index.html +++ b/concepts/function/index.html @@ -1,8 +1,8 @@ -Function | RIDDL DocumentationFunction | RIDDL Documentation + -
+Occurs In Contexts Entities Handlers Contains Fields Statements Functions ">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/group/index.html b/concepts/group/index.html index c2073b68c..36370f51d 100644 --- a/concepts/group/index.html +++ b/concepts/group/index.html @@ -1,8 +1,8 @@ -Group | RIDDL DocumentationGroup | RIDDL Documentation + -
+HTML forms, pages, containers, and sections mobile application screens, pages, forms and containers accordions (vertically stacked list of items with show/hide functionality) A UI designer is free to arrange the contained elements in any fashion, but presumably in a way that is consistent with their overall UI design theme.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/handler/index.html b/concepts/handler/index.html index 0ead2e798..4a4651dfa 100644 --- a/concepts/handler/index.html +++ b/concepts/handler/index.html @@ -1,8 +1,8 @@ -Handlers | RIDDL DocumentationHandlers | RIDDL Documentation + -
+statements. The statements provide the business logic that should be executed upon receipt of the message.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +handle an event
\ No newline at end of file diff --git a/concepts/include/index.html b/concepts/include/index.html index 0b587bc86..a1052dc2f 100644 --- a/concepts/include/index.html +++ b/concepts/include/index.html @@ -1,11 +1,11 @@ -Includes | RIDDL DocumentationIncludes | RIDDL Documentation + -
+Contains Content relevant to the definition in which it is used. The input must conform to the hierarchy shown in the index">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +to the hierarchy shown in the index

\ No newline at end of file diff --git a/concepts/index.html b/concepts/index.html index 58014119d..2d245e685 100644 --- a/concepts/index.html +++ b/concepts/index.html @@ -1,11 +1,11 @@ -Concepts | RIDDL DocumentationConcepts | RIDDL Documentation + -
+Definitional Hierarchy Definitions in RIDDL are arranged in a hierarchy. Definitions that contain other definitions are known as containers or parents.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

With those clarifying simplifications, here’s the hierarchy:

Next

When you’re done exploring all the concepts, check out our guides next.

Full Index -

\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/inlet/index.html b/concepts/inlet/index.html index 3aca6b983..140bd74f6 100644 --- a/concepts/inlet/index.html +++ b/concepts/inlet/index.html @@ -1,8 +1,8 @@ -Inlets | RIDDL DocumentationInlets | RIDDL Documentation + -
+Occurs In Processors Entity Contains Type ">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/input/index.html b/concepts/input/index.html index fff781781..3c88fda44 100644 --- a/concepts/input/index.html +++ b/concepts/input/index.html @@ -1,8 +1,8 @@ -Input | RIDDL DocumentationInput | RIDDL Documentation + -
+the submission of a typical htML form a user could fill in, the tap of a button on a mobile device, the selection of items from a list on a native application, a voice response providing information via any IVR system, a thought interpreted by a neural link, a physical movement interpreted by a motion-detection device, a retinal scan, picking items from lists of information by looking and blinking or any other system by which a human may provide information to a machine The nature of the implementation for an input is up to the UI Designer.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/invariant/index.html b/concepts/invariant/index.html index 8914fb59c..883421d8a 100644 --- a/concepts/invariant/index.html +++ b/concepts/invariant/index.html @@ -1,8 +1,8 @@ -Invariants | RIDDL DocumentationInvariants | RIDDL Documentation + -
+Occurs In Entities - specifies a rule on the state of an entity Functions - specifies a rule on the input parameters of a function Contains Nothing">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

Contains -

Nothing

\ No newline at end of file +

Nothing

\ No newline at end of file diff --git a/concepts/joint/index.html b/concepts/joint/index.html index a9e5daa7f..2580b1f0d 100644 --- a/concepts/joint/index.html +++ b/concepts/joint/index.html @@ -1,11 +1,11 @@ -Joints | RIDDL DocumentationJoints | RIDDL Documentation + -
+Occurs In Plants Contains Nothing">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +

Nothing

\ No newline at end of file diff --git a/concepts/message/index.html b/concepts/message/index.html index 3c7d53799..05befbded 100644 --- a/concepts/message/index.html +++ b/concepts/message/index.html @@ -1,4 +1,4 @@ -Messages | RIDDL DocumentationMessages | RIDDL Documentation + -
+Differences Between Kinds of Messages RIDDL follows Bertrand Meyer’s notion of command/query separation which states, in the context of object-oriented programming in Eiffel that:">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
KindIn Regard To Handling By Processor
CommandIntent To Update Projection State
EventThe Projection’s State Was Modified
QueryIntent to Read Projection State
ResultResult Of Reading Projection State

How Messages Are Handled By Projections

KindIn Regard To Handling By Projection
CommandIntent To Update Projection State
EventThe Projection’s State Was Modified
QueryIntent to Read Projection State
ResultResult Of Reading Projection State

Occurs In

All Vital Definitions

Contains -

Fields

  1. Meyer, Bertrand. “Eiffel: a language for software engineering”. p. 22 ↩︎

\ No newline at end of file +

Fields

  1. Meyer, Bertrand. “Eiffel: a language for software engineering”. p. 22 ↩︎

\ No newline at end of file diff --git a/concepts/onclause/index.html b/concepts/onclause/index.html index 3fb7c4b96..47c98c26b 100644 --- a/concepts/onclause/index.html +++ b/concepts/onclause/index.html @@ -1,8 +1,8 @@ -On Clauses | RIDDL DocumentationOn Clauses | RIDDL Documentation + -
+There are fours kinds of On Clauses:">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

Contains

\ No newline at end of file +when the event occurs
\ No newline at end of file diff --git a/concepts/option/index.html b/concepts/option/index.html index 0d3b3ffef..0e5db19c5 100644 --- a/concepts/option/index.html +++ b/concepts/option/index.html @@ -1,8 +1,8 @@ -Options | RIDDL DocumentationOptions | RIDDL Documentation + -
+Every vital definition in RIDDL allows a technology option that takes any number of string arguments.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +arguments.

\ No newline at end of file diff --git a/concepts/outlet/index.html b/concepts/outlet/index.html index b60b09913..60b9d116e 100644 --- a/concepts/outlet/index.html +++ b/concepts/outlet/index.html @@ -1,8 +1,8 @@ -Outlets | RIDDL DocumentationOutlets | RIDDL Documentation + -
+Occurs In Processors Entity Contains Type ">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/output/index.html b/concepts/output/index.html index 561f748f5..4d4c6ff7d 100644 --- a/concepts/output/index.html +++ b/concepts/output/index.html @@ -1,8 +1,8 @@ -Output | RIDDL DocumentationOutput | RIDDL Documentation + -
+the text shown on a web page or mobile application the display of an interactive graphic, chart, etc. the presentation of a video or audio recording haptic, olfactory or gustatory feedback any other way in which a human can receive information from a machine.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/pipe/index.html b/concepts/pipe/index.html index eeeb5271e..ecc0b3abf 100644 --- a/concepts/pipe/index.html +++ b/concepts/pipe/index.html @@ -1,11 +1,11 @@ -Pipes | RIDDL DocumentationPipes | RIDDL Documentation + -
+Pipe End Connections Pipes have two ends, from and to, and each must be connected to a processor.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +

Nothing

\ No newline at end of file diff --git a/concepts/processor/index.html b/concepts/processor/index.html index 6ca6b1d74..639d074be 100644 --- a/concepts/processor/index.html +++ b/concepts/processor/index.html @@ -1,8 +1,8 @@ -Processors | RIDDL DocumentationProcessors | RIDDL Documentation + -
+Inlets An inlet provides the name and data type for an input to the processor. There can be multiple inlets to the processor or none. A processor with no inlets defined is called a source since it originates data by itself.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/projector/index.html b/concepts/projector/index.html index 6dea20cf4..67448f4e9 100644 --- a/concepts/projector/index.html +++ b/concepts/projector/index.html @@ -1,11 +1,11 @@ -Projectors | RIDDL DocumentationProjectors | RIDDL Documentation + -
+Projections transform update events from entities into a data set that can be more easily queried. Projections have handlers that specify both how to apply updates to the projections state and satisfy queries against that state.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/repository/index.html b/concepts/repository/index.html index 0f2bb1e7f..0b0b45599 100644 --- a/concepts/repository/index.html +++ b/concepts/repository/index.html @@ -1,5 +1,5 @@ -Repository | RIDDL Documentation -
+Repository | RIDDL Documentation +
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/root/index.html b/concepts/root/index.html index 8dc40c8de..643f45f3c 100644 --- a/concepts/root/index.html +++ b/concepts/root/index.html @@ -1,5 +1,5 @@ -Root | RIDDL Documentation -
+Root | RIDDL Documentation +
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/saga/index.html b/concepts/saga/index.html index e97ad06cf..22eb5b34f 100644 --- a/concepts/saga/index.html +++ b/concepts/saga/index.html @@ -1,8 +1,8 @@ -Sagas | RIDDL DocumentationSagas | RIDDL Documentation + -
+Occurs In Contexts Contains SagaStep ">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/sagastep/index.html b/concepts/sagastep/index.html index ce4748e93..bad50cb7a 100644 --- a/concepts/sagastep/index.html +++ b/concepts/sagastep/index.html @@ -1,8 +1,8 @@ -Saga Steps | RIDDL DocumentationSaga Steps | RIDDL Documentation + -
+Occurs In Contexts Contains Statements ">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

Saga Steps

One step in a saga. Each step has input arguments and yields output. It also has both do and undo examples for its action and compensating action.

Occurs In

Contains -

\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/state/index.html b/concepts/state/index.html index c0ac662d7..fe0c15110 100644 --- a/concepts/state/index.html +++ b/concepts/state/index.html @@ -1,11 +1,11 @@ -States | RIDDL DocumentationStates | RIDDL Documentation + -
+Occurs In Entities Contains Fields Handler ">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/statement/index.html b/concepts/statement/index.html index 723f89466..a54bc4e54 100644 --- a/concepts/statement/index.html +++ b/concepts/statement/index.html @@ -1,8 +1,8 @@ -Statement | RIDDL DocumentationStatement | RIDDL Documentation + -
+Name Description Arbitrary A textually described arbitrary statement Ask Send a message to an entity, asynchronously process result Become Instructs an entity change to a new handler Error Produce an error with a message ForEach Invoke statements on each item of a multi-valued field IfThenElse Evaluate a condition and choose execute a statement set FunctionCall Call a function to get a result Morph Morph the state of an entity to a new state Publish Publish a message to a pipe Reply Provide the reply message to the entity that invoked a query Return Return a value from a function Set Set a field value Tell Send a message to an entity directly, do not wait for result Level of Detail Statements are aimed at writing pseudocode in a structured but abstract way.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +things in the system models. None of these are definitions.

\ No newline at end of file diff --git a/concepts/term/index.html b/concepts/term/index.html index ea417a65c..cb0b547c4 100644 --- a/concepts/term/index.html +++ b/concepts/term/index.html @@ -1,11 +1,11 @@ -Terms | RIDDL DocumentationTerms | RIDDL Documentation + -
+Contains Nothing">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +

Nothing

\ No newline at end of file diff --git a/concepts/type/index.html b/concepts/type/index.html index f1d7039a8..7ee5d2eeb 100644 --- a/concepts/type/index.html +++ b/concepts/type/index.html @@ -1,8 +1,8 @@ -Types | RIDDL DocumentationTypes | RIDDL Documentation + -
+A type defines the shape of some information. There are many kinds of type definitions allowed, so we have grouped them into categories:">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/concepts/user/index.html b/concepts/user/index.html index bf92303ad..23c020af9 100644 --- a/concepts/user/index.html +++ b/concepts/user/index.html @@ -1,8 +1,8 @@ -User | RIDDL DocumentationUser | RIDDL Documentation + -
+Occurs In Domains Contains Nothing (Leaf definition)">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +

Nothing (Leaf definition)

\ No newline at end of file diff --git a/concepts/value/index.html b/concepts/value/index.html index f6c983acd..72f32a19a 100644 --- a/concepts/value/index.html +++ b/concepts/value/index.html @@ -1,8 +1,8 @@ -Value | RIDDL DocumentationValue | RIDDL Documentation + -
+Occurs In Statements Contains Values ae self-contained and only contain other values.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +

Values ae self-contained and only contain other values.

\ No newline at end of file diff --git a/concepts/vital/index.html b/concepts/vital/index.html index 71846cab3..de08e3b2f 100644 --- a/concepts/vital/index.html +++ b/concepts/vital/index.html @@ -1,14 +1,14 @@ -Vital Definitions | RIDDL DocumentationVital Definitions | RIDDL Documentation + -
+Adaptors, Applications, Contexts, Domains, Functions, Entities, Epic. Processors, Projectors, Repositories Sagas, and ">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +Author.

These are the vital definitions:

\ No newline at end of file diff --git a/future-work/akka/index.html b/future-work/akka/index.html index c4914979c..75f14024c 100644 --- a/future-work/akka/index.html +++ b/future-work/akka/index.html @@ -1,8 +1,8 @@ -Akka | RIDDL DocumentationAkka | RIDDL Documentation + -
+This translator recognizes that its output will be co-mingled with the business logic output that developers are writing and keeps them separate.">
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +interface and there is no side-car aspect in the runtime.
\ No newline at end of file diff --git a/future-work/analyses/index.html b/future-work/analyses/index.html index 9709db050..56b0bbaa9 100644 --- a/future-work/analyses/index.html +++ b/future-work/analyses/index.html @@ -1,5 +1,5 @@ -Analyses | RIDDL Documentation -
+Analyses | RIDDL Documentation +
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

Analyses

Uses/Used-by

Common to many programming language compilers, RIDDL too needs to be able to generate a pair of maps

  1. uses = key is a definition, value is a list of definitions used by the key
  2. used-by = key is a definition, value is a list of definitions that use -the key
\ No newline at end of file +the key
\ No newline at end of file diff --git a/future-work/bast/index.html b/future-work/bast/index.html index f5fb10aaf..c33707d87 100644 --- a/future-work/bast/index.html +++ b/future-work/bast/index.html @@ -1,5 +1,5 @@ -Binary AST | RIDDL Documentation -
+Binary AST | RIDDL Documentation +
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +
\ No newline at end of file diff --git a/future-work/diagrams/index.html b/future-work/diagrams/index.html index ee63c2361..0c5557253 100644 --- a/future-work/diagrams/index.html +++ b/future-work/diagrams/index.html @@ -1,5 +1,5 @@ -Diagrams | RIDDL Documentation -
+Diagrams | RIDDL Documentation +
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

Diagrams

\ No newline at end of file +justify-between" itemprop=breadcrumb>
  1. Index
  2. /
  3. Future Work
  4. /
  5. Diagrams
Edit page

Diagrams

\ No newline at end of file diff --git a/future-work/index.html b/future-work/index.html index 1d58d60fd..efc34dbd2 100644 --- a/future-work/index.html +++ b/future-work/index.html @@ -1,5 +1,5 @@ -Future Work | RIDDL Documentation -
+Future Work | RIDDL Documentation +
RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
\ No newline at end of file +Architecture, DDD, REST, DCOM, gRPC, etc.
  • Support for Read Projections and Read Models (plugins for databases)
  • Support for graphQL and gRPC
    • \ No newline at end of file diff --git a/future-work/kalix/index.html b/future-work/kalix/index.html index a214c2486..bfa9e774e 100644 --- a/future-work/kalix/index.html +++ b/future-work/kalix/index.html @@ -1,5 +1,5 @@ -Kalix | RIDDL Documentation -
    +Kalix | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +with a fill-in-the-blanks style for just the business logic.

    \ No newline at end of file diff --git a/future-work/openapi/index.html b/future-work/openapi/index.html index 58aa18966..de7bf6af5 100644 --- a/future-work/openapi/index.html +++ b/future-work/openapi/index.html @@ -1,5 +1,5 @@ -OpenAPI | RIDDL Documentation -
    +OpenAPI | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    OpenAPI

    RIDDL can generate OpenAPI (Swagger) input to document Application Programming -Interfaces

    \ No newline at end of file +Interfaces

    \ No newline at end of file diff --git a/future-work/others/index.html b/future-work/others/index.html index ae187531d..1bff6d58a 100644 --- a/future-work/others/index.html +++ b/future-work/others/index.html @@ -1,5 +1,5 @@ -Other Translators | RIDDL Documentation -
    +Other Translators | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    1. Index
    2. /
    3. Future Work
    4. /
    5. Other Translators

    Other Translators

    \ No newline at end of file +justify-between" itemprop=breadcrumb>
    1. Index
    2. /
    3. Future Work
    4. /
    5. Other Translators
    Edit page

    Other Translators

    \ No newline at end of file diff --git a/guides/authors/design-tips/index.html b/guides/authors/design-tips/index.html index 04cd9788c..dfbe6fb7b 100644 --- a/guides/authors/design-tips/index.html +++ b/guides/authors/design-tips/index.html @@ -1,5 +1,5 @@ -Design Tips | RIDDL Documentation -
    +Design Tips | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +

    TBD

    \ No newline at end of file diff --git a/guides/authors/design/index.html b/guides/authors/design/index.html index f1517c72b..2b82b8a19 100644 --- a/guides/authors/design/index.html +++ b/guides/authors/design/index.html @@ -1,5 +1,5 @@ -Design | RIDDL Documentation -
    +Design | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +justify-between" itemprop=breadcrumb>
    1. Index
    2. /
    3. Guides
    4. /
    5. Author's Guide
    6. /
    7. Design
    Edit page

    Design

    This section helps authors with the task of using RIDDL to design a system.

    \ No newline at end of file diff --git a/guides/authors/design/patterns/command-event/index.html b/guides/authors/design/patterns/command-event/index.html index 0da8b5544..9a186adbe 100644 --- a/guides/authors/design/patterns/command-event/index.html +++ b/guides/authors/design/patterns/command-event/index.html @@ -1,5 +1,5 @@ -Command/Event Patterns | RIDDL Documentation -
    +Command/Event Patterns | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/guides/authors/design/patterns/command-event/optional-parameters/index.html b/guides/authors/design/patterns/command-event/optional-parameters/index.html index a63298157..38d0e6a25 100644 --- a/guides/authors/design/patterns/command-event/optional-parameters/index.html +++ b/guides/authors/design/patterns/command-event/optional-parameters/index.html @@ -1,5 +1,5 @@ -3 - Optional or List Parameters | RIDDL Documentation -
    +3 - Optional or List Parameters | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +especially be taken into consideration when comparing this solution to surfaced parameters instead

    \ No newline at end of file diff --git a/guides/authors/design/patterns/command-event/same-event/index.html b/guides/authors/design/patterns/command-event/same-event/index.html index 58f33b03e..aa3553875 100644 --- a/guides/authors/design/patterns/command-event/same-event/index.html +++ b/guides/authors/design/patterns/command-event/same-event/index.html @@ -1,5 +1,5 @@ -1 - Same Event | RIDDL Documentation -
    +1 - Same Event | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    In an event driven system it is important to have distinct events for each operation such that there is a structural difference in the responses. This pattern is advised against for diverse sets of operations, and keeping in mind -advantages of other patterns mentioned in this section.

    \ No newline at end of file +advantages of other patterns mentioned in this section.

    \ No newline at end of file diff --git a/guides/authors/design/patterns/command-event/same-parameters/index.html b/guides/authors/design/patterns/command-event/same-parameters/index.html index a85bcf189..22161a833 100644 --- a/guides/authors/design/patterns/command-event/same-parameters/index.html +++ b/guides/authors/design/patterns/command-event/same-parameters/index.html @@ -1,5 +1,5 @@ -2 - Same Parameters | RIDDL Documentation -
    +2 - Same Parameters | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +antipattern from that perspective.

    \ No newline at end of file diff --git a/guides/authors/design/patterns/command-event/surfaced-parameters/index.html b/guides/authors/design/patterns/command-event/surfaced-parameters/index.html index b1e8f4709..1bd6a93ae 100644 --- a/guides/authors/design/patterns/command-event/surfaced-parameters/index.html +++ b/guides/authors/design/patterns/command-event/surfaced-parameters/index.html @@ -1,5 +1,5 @@ -4 - Surfaced Parameters | RIDDL Documentation -
    +4 - Surfaced Parameters | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +or RIDDL Compound Types.

    \ No newline at end of file diff --git a/guides/authors/design/patterns/index.html b/guides/authors/design/patterns/index.html index e0d469336..584be97a5 100644 --- a/guides/authors/design/patterns/index.html +++ b/guides/authors/design/patterns/index.html @@ -1,5 +1,5 @@ -Patterns | RIDDL Documentation -
    +Patterns | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +justify-between" itemprop=breadcrumb>
    1. Index
    2. /
    3. Guides
    4. /
    5. Author's Guide
    6. /
    7. Design
    8. /
    9. Patterns
    Edit page

    Patterns

    This section helps authors with the task of using RIDDL to design a system via recommended patterns for various systems.

    \ No newline at end of file diff --git a/guides/authors/index.html b/guides/authors/index.html index 681e0ad10..c8f30f289 100644 --- a/guides/authors/index.html +++ b/guides/authors/index.html @@ -1,5 +1,5 @@ -Author's Guide | RIDDL Documentation -
    +Author's Guide | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +RIDDL sources to improve the overall correctness in the outputs from RIDDL.

    \ No newline at end of file diff --git a/guides/authors/syntaxcheatsheet/index.html b/guides/authors/syntaxcheatsheet/index.html index 7f3bc3ae2..d2eda1304 100644 --- a/guides/authors/syntaxcheatsheet/index.html +++ b/guides/authors/syntaxcheatsheet/index.html @@ -1,5 +1,5 @@ -Syntax Cheat Sheet | RIDDL Documentation -
    +Syntax Cheat Sheet | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    1. Index
    2. /
    3. Guides
    4. /
    5. Author's Guide
    6. /
    7. Syntax Cheat Sheet

    Syntax Cheat Sheet

    TBD

    \ No newline at end of file +justify-between" itemprop=breadcrumb>
    1. Index
    2. /
    3. Guides
    4. /
    5. Author's Guide
    6. /
    7. Syntax Cheat Sheet
    Edit page

    Syntax Cheat Sheet

    TBD

    \ No newline at end of file diff --git a/guides/authors/syntaxreference/index.html b/guides/authors/syntaxreference/index.html index 8bde8e599..e8c2b2ccc 100644 --- a/guides/authors/syntaxreference/index.html +++ b/guides/authors/syntaxreference/index.html @@ -1,5 +1,5 @@ -Syntax Reference | RIDDL Documentation -
    +Syntax Reference | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    1. Index
    2. /
    3. Guides
    4. /
    5. Author's Guide
    6. /
    7. Syntax Reference

    Syntax Reference

    TBD

    \ No newline at end of file +justify-between" itemprop=breadcrumb>
    1. Index
    2. /
    3. Guides
    4. /
    5. Author's Guide
    6. /
    7. Syntax Reference
    Edit page

    Syntax Reference

    TBD

    \ No newline at end of file diff --git a/guides/developers/checking-documentation/index.html b/guides/developers/checking-documentation/index.html index 4ad100dff..e323dfa74 100644 --- a/guides/developers/checking-documentation/index.html +++ b/guides/developers/checking-documentation/index.html @@ -1,8 +1,9 @@ -Checking Documentation | RIDDL DocumentationChecking Documentation | RIDDL Documentation + -
    +cd doc/src/hugo hugo server --disableFastRender -D The --disableFastRender means that hugo won’t cache results but read from source on each request. The -D option instructs to load all pages, even the ones marked as drafts.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    You can continue editing while the server is running. This allows you to validate your work on the markdown files visually in the browser. Whenever you change a markdown file, Hugo will notice and reload the browser page -automatically if the viewed markdown page changed.

    \ No newline at end of file +automatically if the viewed markdown page changed.

    \ No newline at end of file diff --git a/guides/developers/dependencies/index.html b/guides/developers/dependencies/index.html index 4f35b9062..2b1bd4586 100644 --- a/guides/developers/dependencies/index.html +++ b/guides/developers/dependencies/index.html @@ -1,8 +1,8 @@ -Dependencies | RIDDL DocumentationDependencies | RIDDL Documentation + -
    +fastparse uses macros and is waiting for bugs in scala 3 to be fixed pureconfig is nearly ready for scala 3 ">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Dependencies

    Dependencies

    The riddl code base targets Java 17 and Scala 2.13.7 with -XSource:3 in preparation for Scala 3.0 code conversion. Moving to Scala 3 requires all -dependencies to make the same transition:

    \ No newline at end of file +dependencies to make the same transition:

    \ No newline at end of file diff --git a/guides/developers/grammar/common/index.html b/guides/developers/grammar/common/index.html index 2de558b4f..8335b1467 100644 --- a/guides/developers/grammar/common/index.html +++ b/guides/developers/grammar/common/index.html @@ -1,8 +1,8 @@ -Common | RIDDL DocumentationCommon | RIDDL Documentation + -
    +(* Common RIDDL EBNF Grammar Productions *) (******************************************************************** COMMON *) any char = ? any UTF-8 character ? ; any but newline = any char - ( "\n" | "\r" ) ; nonquote = any char - '"' ; digits = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ; literalInteger = digits literalString = quote nonquote quote ; literalStrings = literalString { literalString } ; markdownLine = verticalBar, any but newline, newline ; markdownLines= markdownLine { markdownLine.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/guides/developers/grammar/context/index.html b/guides/developers/grammar/context/index.html index 2e2a770b4..ec0b0a0ea 100644 --- a/guides/developers/grammar/context/index.html +++ b/guides/developers/grammar/context/index.html @@ -1,8 +1,8 @@ -Context | RIDDL DocumentationContext | RIDDL Documentation + -
    +(* RIDDL EBNF Grammar for bounded contexts *) context options = options("wrapper" | "gateway" | "function") context include = "include", literalString context definitions = typedef | entity | adaptor | interaction | contextInclude context = "context", identifier, is, open, (undefined | context options, context definitions), close, description } ">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/guides/developers/grammar/domain/index.html b/guides/developers/grammar/domain/index.html index 14a9ba383..9b5ba3508 100644 --- a/guides/developers/grammar/domain/index.html +++ b/guides/developers/grammar/domain/index.html @@ -1,8 +1,8 @@ -Domain | RIDDL DocumentationDomain | RIDDL Documentation + -
    +(* RIDDL EBNF Grammar for knowledge domains *) domain include = "include", literalString domain content = typeDef | topic | interaction | context | domain | domainInclude domain = "domain", identifier, "is", "{", (undefined | domainContent), "}", description ">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/guides/developers/grammar/entity/index.html b/guides/developers/grammar/entity/index.html index d3edcb4ec..d391b92bf 100644 --- a/guides/developers/grammar/entity/index.html +++ b/guides/developers/grammar/entity/index.html @@ -1,5 +1,5 @@ -Entity | RIDDL Documentation -
    +Entity | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    State

    A state is defined with the state keyword in the content of an entity using this syntax:

    state = "state", identifier, "is", aggregate, description
-

    For details see the following production descriptions

    \ No newline at end of file +

    For details see the following production descriptions

    \ No newline at end of file diff --git a/guides/developers/grammar/index.html b/guides/developers/grammar/index.html index b72d2bac3..ee6683d32 100644 --- a/guides/developers/grammar/index.html +++ b/guides/developers/grammar/index.html @@ -1,14 +1,14 @@ -Grammar | RIDDL DocumentationGrammar | RIDDL Documentation + -
    +all characters = ? any utf-8 character ? ; quoted string = '"', { all characters - '"' }, '"'; This form can be quite technical and is intended for those who are familiar with EBNF format and lexical parsing.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +other files
  • root - Top level root level (“file scope”).
  • domain - Defining domains
  • context - Defining contexts
  • entity - Defining entities
    • \ No newline at end of file diff --git a/guides/developers/grammar/root/index.html b/guides/developers/grammar/root/index.html index 8ba6bf6f4..0feea8735 100644 --- a/guides/developers/grammar/root/index.html +++ b/guides/developers/grammar/root/index.html @@ -1,5 +1,5 @@ -Root | RIDDL Documentation -
    +Root | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Root

    (* RIDDL Grammar For Root - TBD *)
 
 root = domain | domain include
-

    TBD

    \ No newline at end of file +

    TBD

    \ No newline at end of file diff --git a/guides/developers/grammar/terminals/index.html b/guides/developers/grammar/terminals/index.html index 03b4f2647..79d3f3583 100644 --- a/guides/developers/grammar/terminals/index.html +++ b/guides/developers/grammar/terminals/index.html @@ -1,8 +1,8 @@ -Terminals | RIDDL DocumentationTerminals | RIDDL Documentation + -
    +(* Terminal symbol definitions in various categories *) Terminals = Punctuation | Options | Keywords | Predefined | Readability | Operators; Punctuation = asterisk | comma | colon | curlyOpen | curlyClose | dot | equals | ellipsis | ellipsisQuestion | plus | question | quote | roundOpen | roundClose | squareOpen | squareClose | undefined | verticalBar ; asterisk = "*"; comma = ","; colon = ":"; curlyOpen = "{"; curlyClose = "}"; dot = ".">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/guides/developers/index.html b/guides/developers/index.html index b1d0ec89d..67d79291e 100644 --- a/guides/developers/index.html +++ b/guides/developers/index.html @@ -1,5 +1,5 @@ -Developer's Guide | RIDDL Documentation -
    +Developer's Guide | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Developer's Guide

    Developers are the technical experts that advance RIDDL’s state of the art. They develop the tooling and documentation that makes up RIDDL. Since RIDDL is an open source project, developers can be affiliated with many organizations, -presumably the organizations that derive utility from RIDDL.

    Developers must be experts in:

    \ No newline at end of file +presumably the organizations that derive utility from RIDDL.

    Developers must be experts in:

    \ No newline at end of file diff --git a/guides/developers/principles/index.html b/guides/developers/principles/index.html index 360708f41..da0f6139a 100644 --- a/guides/developers/principles/index.html +++ b/guides/developers/principles/index.html @@ -1,8 +1,8 @@ -Principles | RIDDL DocumentationPrinciples | RIDDL Documentation + -
    +1: Declarative RIDDL is not an implementation language and does not pretend to be computationally complete. RIDDL adopts this what not how principle. Details are for software developers. The analyst or architect that writes RIDDL documents wants to only specify what the system is while abstracting away the process of constructing it.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +utility. RIDDL can therefore be used to produce:

    \ No newline at end of file diff --git a/guides/developers/releasing/index.html b/guides/developers/releasing/index.html index 21e99000e..c0ca5cc60 100644 --- a/guides/developers/releasing/index.html +++ b/guides/developers/releasing/index.html @@ -1,11 +1,11 @@ -Releasing RIDDL | RIDDL DocumentationReleasing RIDDL | RIDDL Documentation + -
    +% cd riddl # top level directory of repository % sbt > ; clean ; test ; test ; test > project plugin > scripted ... [info] All tests passed. If all tests do not pass, stop and fix the software. Note that the tests are run three times quickly.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    The change to this file does not need to be included in the release tag. Always do this last because other projects are dependent on this action and the -action is dependent on the uploaded artifacts.

    \ No newline at end of file +action is dependent on the uploaded artifacts.

    \ No newline at end of file diff --git a/guides/developers/testing/index.html b/guides/developers/testing/index.html index d23c844ad..1eb0b6b02 100644 --- a/guides/developers/testing/index.html +++ b/guides/developers/testing/index.html @@ -1,5 +1,5 @@ -testing | RIDDL Documentation -
    +testing | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    In examples/src/test/scala there is a CheckExamplesSpec.scala which runs the parser and validator on the examples in examples/src/riddl. Each sub-directory there is a separate example. They are expected to parse and -validate cleanly without issue

    \ No newline at end of file +validate cleanly without issue

    \ No newline at end of file diff --git a/guides/domain-experts/index.html b/guides/domain-experts/index.html index 0d1622fa9..b7bd8ae9e 100644 --- a/guides/domain-experts/index.html +++ b/guides/domain-experts/index.html @@ -1,5 +1,5 @@ -Domain Expert's Guide | RIDDL Documentation -
    +Domain Expert's Guide | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +these changes and be able to evangelize them as they interact with their peers.

    \ No newline at end of file diff --git a/guides/implementors/index.html b/guides/implementors/index.html index 0dcc77080..d547f218d 100644 --- a/guides/implementors/index.html +++ b/guides/implementors/index.html @@ -1,5 +1,5 @@ -Implementor's Guide | RIDDL Documentation -
    +Implementor's Guide | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +team and sound reactive architecture.

    \ No newline at end of file diff --git a/guides/implementors/ways-to-use-riddl/index.html b/guides/implementors/ways-to-use-riddl/index.html index a1057e43c..64deb458e 100644 --- a/guides/implementors/ways-to-use-riddl/index.html +++ b/guides/implementors/ways-to-use-riddl/index.html @@ -1,5 +1,5 @@ -Different Ways To Get/Use RIDDL | RIDDL Documentation -
    +Different Ways To Get/Use RIDDL | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/guides/index.html b/guides/index.html index e6221ed07..a000af8be 100644 --- a/guides/index.html +++ b/guides/index.html @@ -1,11 +1,11 @@ -Guides | RIDDL DocumentationGuides | RIDDL Documentation + -
    +Expert's Guide For knowledge domain experts who would provide concepts, structure, and event flows to RIDDL authors. Author's Guide For those who will write RIDDL specifications and must know the language intricacies for full and accurate specifications.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Developers are the technical experts that advance RIDDL’s state of the art. They develop the tooling and documentation that makes up RIDDL. Since RIDDL is an open source project, developers can be affiliated with many organizations, -presumably the organizations that derive utility from RIDDL.

    \ No newline at end of file +presumably the organizations that derive utility from RIDDL.

    \ No newline at end of file diff --git a/index.html b/index.html index d11355f00..a54e4cd64 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ -RIDDL Documentation -
    +RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/introduction/how-can-i-get-help/index.html b/introduction/how-can-i-get-help/index.html index 6df7f4306..2a7294c99 100644 --- a/introduction/how-can-i-get-help/index.html +++ b/introduction/how-can-i-get-help/index.html @@ -1,8 +1,8 @@ -How Can I Get Help? | RIDDL DocumentationHow Can I Get Help? | RIDDL Documentation + -
    +I Need A Bug Fixed I Need RIDDL To Generate Something Else I Want To Make A Feature Suggestion I Need Commercial Support I Just Want To Chat With Someone About RIDDL I Need A Bug Fixed While RIDDL is competent enough to be used for a production software project, we still consider it to be in a pre-release, early preview stage.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +

    You can use the Discussions feature on GitHub

    \ No newline at end of file diff --git a/introduction/index.html b/introduction/index.html index f226f5dcc..726c0ac08 100644 --- a/introduction/index.html +++ b/introduction/index.html @@ -1,8 +1,8 @@ -Introduction | RIDDL DocumentationIntroduction | RIDDL Documentation + -
    +What Is RIDDL? What can RIDDL do? What is RIDDL Based On? Who Can Benefit From RIDDL? Who Made RIDDL Possible? How Can I Get Help? Click on the above links to explore this section; or, go to the next recommended section: Conceptual Overview.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    1. Index
    2. /
    3. Introduction
    \ No newline at end of file +section: Conceptual Overview.

    \ No newline at end of file diff --git a/introduction/what-can-riddl-do/index.html b/introduction/what-can-riddl-do/index.html index 6d683a83a..6a9d9083d 100644 --- a/introduction/what-can-riddl-do/index.html +++ b/introduction/what-can-riddl-do/index.html @@ -1,8 +1,8 @@ -What can RIDDL do? | RIDDL DocumentationWhat can RIDDL do? | RIDDL Documentation + -
    +Input The input to riddlc is always a single file with the .riddl suffix. This is a text file that contains definitions in the RIDDL syntax.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +approach for system design evolution.

  • Kuberenetes - generating Kubernetes deployment descriptors, etc.

  • RIDDL sources produce two kinds of output:

  • Specification: Specification outputs are the “requirements” of the domain model. Domain experts spend most of their time here - adding detail, reviewing for completeness/correctness, and establishing the domain model - which includes defining a ubiquitous language. Most of this work is done by reviewing the web site generated from RIDDL sources. Beyond textual definitions and descriptions of Domains, Contexts, Entities, Plants, Functions, etc. specification outputs may also include wireframe mockups, diagrams of various types that add clarity to the definition and interactions within the domain, for example, Context Maps, Flow Charts, Sequence Diagrams, State Machines, Entity Relationships.

    When the delivery team begins building, the system specification outputs become their guide posts as they build. Undoubtedly, the implementation team will need to engage with domain experts to get additional information and clarity as they develop. Specification outputs provide the baseline from which these conversations happen. The insights gained should be captured in the RIDDL file and new specification outputs generated to reflect these learnings.

  • Implementation: Implementation outputs are intended to accelerate the efforts of the delivery team. As such, these outputs tend to be more technical in nature. Examples of these outputs would include:

    • \ No newline at end of file diff --git a/introduction/what-is-riddl-based-on/index.html b/introduction/what-is-riddl-based-on/index.html index 7c5a1e7a6..ab3f3679f 100644 --- a/introduction/what-is-riddl-based-on/index.html +++ b/introduction/what-is-riddl-based-on/index.html @@ -1,8 +1,8 @@ -What is RIDDL Based On? | RIDDL DocumentationWhat is RIDDL Based On? | RIDDL Documentation + -
    +Domain Driven Design (DDD) Reactive System Architecture (RSA) C4 Model Of Software Architecture Akka Jacobsen Use Cases 2.0 Agile User Stories Behavior Driven Development (BDD) Finite State Machines Command/Query Separation CQRS Event Sourcing Saga Pattern Unified Modeling Language (UML) RIDDL aims to capture business concepts, system designs and architectural details in a way that is consumable by business professionals yet can also be directly translated into various technical and non-technical artifacts, including:">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +format of capturing a user story.

    \ No newline at end of file diff --git a/introduction/what-is-riddl/index.html b/introduction/what-is-riddl/index.html index f737ba430..f4b9480c8 100644 --- a/introduction/what-is-riddl/index.html +++ b/introduction/what-is-riddl/index.html @@ -1,11 +1,11 @@ -What Is RIDDL? | RIDDL DocumentationWhat Is RIDDL? | RIDDL Documentation + -
    +RIDDL is a variety of software libraries and tools, provided in this GitHub repository, that allow humans to work with the language to create their own derivative works.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +please see the tooling section

    \ No newline at end of file diff --git a/introduction/who-can-benefit-from-riddl/index.html b/introduction/who-can-benefit-from-riddl/index.html index de4383a68..d58ec7117 100644 --- a/introduction/who-can-benefit-from-riddl/index.html +++ b/introduction/who-can-benefit-from-riddl/index.html @@ -1,8 +1,8 @@ -Who Can Benefit From RIDDL? | RIDDL DocumentationWho Can Benefit From RIDDL? | RIDDL Documentation + -
    +Consequently, the people who can benefit from RIDDL are those who are building such systems that want a precise and consistent way of specifying its evolving design as a guide to all stakeholders.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +evolving design as a guide to all stakeholders.

    \ No newline at end of file diff --git a/introduction/who-made-riddl-possible/index.html b/introduction/who-made-riddl-possible/index.html index 4ee5d6b8b..bdef5b6aa 100644 --- a/introduction/who-made-riddl-possible/index.html +++ b/introduction/who-made-riddl-possible/index.html @@ -1,8 +1,8 @@ -Who Made RIDDL Possible? | RIDDL DocumentationWho Made RIDDL Possible? | RIDDL Documentation + -
    +Kevin D’Vincenzo An early implementor of a hugo translator that inspired much of the current implementation.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Creator of the Geekdoc theme for [Hugo](http://github. com/gohugo/)

    Simon Brown

    Creator of the C4 Model For Software Architecture

    Vaughn Vernon -

    Author of Domain Driven Design Distilled

    \ No newline at end of file +

    Author of Domain Driven Design Distilled

    \ No newline at end of file diff --git a/language/common/descriptions/index.html b/language/common/descriptions/index.html index 4c45c6fa8..ff51a76a5 100644 --- a/language/common/descriptions/index.html +++ b/language/common/descriptions/index.html @@ -1,11 +1,11 @@ -Descriptions | RIDDL DocumentationDescriptions | RIDDL Documentation + -
    +described by described as described in file "" explained by explained in file "" These four phrases are equivalent but provided to suit the nature of the definitions to which they may be applied.">
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +See this link for more details on hugo

    \ No newline at end of file diff --git a/language/common/doc-conventions/index.html b/language/common/doc-conventions/index.html index 1e05ca3e7..2784fe9af 100644 --- a/language/common/doc-conventions/index.html +++ b/language/common/doc-conventions/index.html @@ -1,11 +1,11 @@ -Documentation Conventions | RIDDL DocumentationDocumentation Conventions | RIDDL Documentation + -
    +domain MyDomain is { ??? } Notes Whenever an incidental note needs to be presented, it will be shown in blue like this paragraph. Recommendations Whenever an important recommendation needs to be made it will be shown in green like this paragraph.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    Whenever a point that will lead to errors or have dangerous consequences needs be made, it will be shown in red like this paragraph.

    Language Definitions

    Whenever an important RIDDL language definition is made, it will appear in a -box like this.
    \ No newline at end of file +box like this.
    \ No newline at end of file diff --git a/language/common/examples/index.html b/language/common/examples/index.html index 9dd01a306..47cf72c5d 100644 --- a/language/common/examples/index.html +++ b/language/common/examples/index.html @@ -1,8 +1,8 @@ -Examples | RIDDL DocumentationExamples | RIDDL Documentation + -
    +Adaptors Handlers Functions Processors Projections Saga Actions Epic Structure Gherkin is a language developed by SmartBear Software, a vendor of software quality tools, for the cucumber testing system. RIDDL uses a subset of the language as SmartBear has defined it. Four constructs are used in RIDDL:">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/language/common/expressions/index.html b/language/common/expressions/index.html index 8a6e494d8..8ad783df3 100644 --- a/language/common/expressions/index.html +++ b/language/common/expressions/index.html @@ -1,8 +1,8 @@ -Expressions | RIDDL DocumentationExpressions | RIDDL Documentation + -
    +Expressions Expressions compute values of arbitrary types. Since RIDDL is not a programming language, the syntax used for expressions is minimal and abstract. There is no attempt in RIDDL to be computationally complete. Supporting expression is merely for the convenience to requirements writers.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +but is provided for convenience.

    \ No newline at end of file diff --git a/language/common/functions/index.html b/language/common/functions/index.html index 10dcdb54c..8afdcc91b 100644 --- a/language/common/functions/index.html +++ b/language/common/functions/index.html @@ -1,8 +1,8 @@ -Functions | RIDDL DocumentationFunctions | RIDDL Documentation + -
    +Example Here’s an example of a function, named riddle, that requires a Subject(String) type and returns a Riddle (String) type.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +to encapsulate repeating logic from an on clause
  • Allow internal entity processing to be specified as part of an interaction
  • etc.
    • Further Content: TBD
    \ No newline at end of file diff --git a/language/common/identifiers/index.html b/language/common/identifiers/index.html index ee33a36cd..d29cb3179 100644 --- a/language/common/identifiers/index.html +++ b/language/common/identifiers/index.html @@ -1,11 +1,11 @@ -Identifiers | RIDDL DocumentationIdentifiers | RIDDL Documentation + -
    +simple: any alphabetic character followed by alphanumerics or underscore quoted: " followed by a string of characters chosen from this set: a-zA-Z0-9_+\-|/@$%&, :" followed by a " Path Identifiers In several places in RIDDL, you may need to reference a definition in another definition.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    The definition of Complicated uses path ^^^C^D.DSimple in the example above. This helps us to see how DSimple is referenced in a complicated path. The complicated part is the ^ between C and D. This path is -interpreted like this:

    \ No newline at end of file +interpreted like this:

    \ No newline at end of file diff --git a/language/common/imports/index.html b/language/common/imports/index.html index 5b90dc16f..f20dcbc16 100644 --- a/language/common/imports/index.html +++ b/language/common/imports/index.html @@ -1,8 +1,8 @@ -Imports | RIDDL DocumentationImports | RIDDL Documentation + -
    +An import statement may be used to import a definition from a BAST file that was generated from a prior compilation. Import statements help to save time when a prior compilation has completed and been saved as a BAST file.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Imports

    This feature is not implemented yet.

    An import statement may be used to import a definition from a BAST file that was generated from a prior compilation. Import statements help to save time when a prior -compilation has completed and been saved as a BAST file.

    \ No newline at end of file +compilation has completed and been saved as a BAST file.

    \ No newline at end of file diff --git a/language/common/includes/index.html b/language/common/includes/index.html index 8f659cbd3..105b9c285 100644 --- a/language/common/includes/index.html +++ b/language/common/includes/index.html @@ -1,8 +1,8 @@ -Includes | RIDDL DocumentationIncludes | RIDDL Documentation + -
    +include "other-file.riddl" The include statement is only permitted where major definitions are expected, specifically at root level, and in the bodies of domain, context, entity, and pipe definitions.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +and pipe definitions.

    \ No newline at end of file diff --git a/language/common/index.html b/language/common/index.html index 37e9755be..b52b313ab 100644 --- a/language/common/index.html +++ b/language/common/index.html @@ -1,8 +1,8 @@ -Common | RIDDL DocumentationCommon | RIDDL Documentation + -
    +Documentation Conventions Language Conventions Descriptions Identifiers Examples Types Expressions Includes Functions Imports Options ">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +will define some things that are common to many definitions:

    \ No newline at end of file diff --git a/language/common/lang-conventions/index.html b/language/common/lang-conventions/index.html index 471af2759..14064950b 100644 --- a/language/common/lang-conventions/index.html +++ b/language/common/lang-conventions/index.html @@ -1,5 +1,5 @@ -Language Conventions | RIDDL Documentation -
    +Language Conventions | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/language/common/options/index.html b/language/common/options/index.html index 1e8a62ccc..b1d841bac 100644 --- a/language/common/options/index.html +++ b/language/common/options/index.html @@ -1,8 +1,8 @@ -Options | RIDDL DocumentationOptions | RIDDL Documentation + -
    +need more detail ">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Options

    Many definitions can have options. These are hints or processing instructions to -the various translator tools.

    • need more detail
    \ No newline at end of file +the various translator tools.

    \ No newline at end of file diff --git a/language/common/types/index.html b/language/common/types/index.html index 4ed07c75f..c6f0360e5 100644 --- a/language/common/types/index.html +++ b/language/common/types/index.html @@ -1,8 +1,8 @@ -Types | RIDDL DocumentationTypes | RIDDL Documentation + -
    +Predefined Types RIDDL supports several predefined types that just “exist” because they are fundamental and well understood in any targeted computing environment. These predefined type names can be used anywhere that a type definition is needed, for example in a field of an entity’s state definition see here">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/language/index.html b/language/index.html index ecd72046d..11f624858 100644 --- a/language/index.html +++ b/language/index.html @@ -1,8 +1,8 @@ -Language | RIDDL DocumentationLanguage | RIDDL Documentation + -
    +Warning This section of the documentation has not been maintained well and is due for re-synchronization with the concepts section Overview Prerequisites Definitional Hierarchy Overview RIDDL is not a Turing complete language. However, it is intended to be used to create systems that are Turing complete. Consequently, RIDDL is not a programming language, it is a system specification language, and not only at software developers.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +hidden at each level.

    Start with the Root.

    \ No newline at end of file diff --git a/language/root/domain/context/adaptor/index.html b/language/root/domain/context/adaptor/index.html index 9d47032bd..85f92ae2a 100644 --- a/language/root/domain/context/adaptor/index.html +++ b/language/root/domain/context/adaptor/index.html @@ -1,5 +1,5 @@ -Adaptors | RIDDL Documentation -
    +Adaptors | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/language/root/domain/context/entity/functions/index.html b/language/root/domain/context/entity/functions/index.html index 3512f8db6..83aacb4c4 100644 --- a/language/root/domain/context/entity/functions/index.html +++ b/language/root/domain/context/entity/functions/index.html @@ -1,5 +1,5 @@ -Function | RIDDL Documentation -
    +Function | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Function

    TBD

    \ No newline at end of file +justify-between" itemprop=breadcrumb>
    1. Index
    2. /
    3. Language
    4. /
    5. Root
    6. /
    7. Domain
    8. /
    9. Context
    10. /
    11. Entities
    12. /
    13. Function
    Edit page

    Function

    TBD

    \ No newline at end of file diff --git a/language/root/domain/context/entity/handler/index.html b/language/root/domain/context/entity/handler/index.html index 5e2a779da..6109ed74e 100644 --- a/language/root/domain/context/entity/handler/index.html +++ b/language/root/domain/context/entity/handler/index.html @@ -1,8 +1,8 @@ -Entity Handler | RIDDL DocumentationEntity Handler | RIDDL Documentation + -
    +Note that a context can define a handlertoo, but they are different compared to the handlers defined in an entity. See Context Handler for details on them. Handlers are specified with the handler keyword and enclose a set of on clauses that specify what to do with a given event when that handler is active. There are four kinds of on clauses distinguished by the kind of message they handle (command, event, query, and reaction) as detailed in the following sections.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +the handler will simply be ignored.

    \ No newline at end of file diff --git a/language/root/domain/context/entity/index.html b/language/root/domain/context/entity/index.html index 14ae1b5c6..0828207bc 100644 --- a/language/root/domain/context/entity/index.html +++ b/language/root/domain/context/entity/index.html @@ -1,8 +1,8 @@ -Entities | RIDDL DocumentationEntities | RIDDL Documentation + -
    +entity Example is { options(...)) // Optional aspects of the entity and code gen hints invariant i is { ... } // Logical assertions that must always be true state s is { ... } // Information retained by the entity function f is { ... } // Functions to eliminate redundancy in handlers handler h is { .">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +

    The links below provide more details on the various sub-definitions of an entity:

    \ No newline at end of file diff --git a/language/root/domain/context/entity/invariants/index.html b/language/root/domain/context/entity/invariants/index.html index 984430167..46f2e87e5 100644 --- a/language/root/domain/context/entity/invariants/index.html +++ b/language/root/domain/context/entity/invariants/index.html @@ -1,5 +1,5 @@ -Invariants | RIDDL Documentation -
    +Invariants | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Operand Types

    \ No newline at end of file +specified, the name of the object must be used with the name of the field, separated by a period.
    \ No newline at end of file diff --git a/language/root/domain/context/entity/options/index.html b/language/root/domain/context/entity/options/index.html index 7806b77c2..3627ececa 100644 --- a/language/root/domain/context/entity/options/index.html +++ b/language/root/domain/context/entity/options/index.html @@ -1,11 +1,11 @@ -Options | RIDDL DocumentationOptions | RIDDL Documentation + -
    +kind - indicates the intended kind of entity in an argument to the kind entity.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +state.

    \ No newline at end of file diff --git a/language/root/domain/context/entity/state/index.html b/language/root/domain/context/entity/state/index.html index 64f1241d5..0aab08f8c 100644 --- a/language/root/domain/context/entity/state/index.html +++ b/language/root/domain/context/entity/state/index.html @@ -1,11 +1,11 @@ -State | RIDDL DocumentationState | RIDDL Documentation + -
    +entity Car { type Propulsion = any of { ICE, Electric, Steam, Diesel, EMDrive } state Static is { wheels: Integer doors: Integer rightHandDrive: Boolean propulsion: Propulsion } } One of the primary purposes of an entity is to represent the characteristics of the entity with state information.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +are needed.

    \ No newline at end of file diff --git a/language/root/domain/context/features/index.html b/language/root/domain/context/features/index.html index b63479e3a..da49a4e8a 100644 --- a/language/root/domain/context/features/index.html +++ b/language/root/domain/context/features/index.html @@ -1,8 +1,8 @@ -Features | RIDDL DocumentationFeatures | RIDDL Documentation + -
    +Feature "Guess the word" is { // The first example has two steps Scenario "Maker starts a game" is { When the Maker starts a game Then the Maker waits for a Breaker to join } // The second example has three steps Scenario "Breaker joins a game" is { Given the Maker has started a game with a word When the Breaker joins the Maker's game Then the Breaker must guess a word knowing the length of the Maker's word choice.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/language/root/domain/context/handler/index.html b/language/root/domain/context/handler/index.html index a1843cef7..8a942ae36 100644 --- a/language/root/domain/context/handler/index.html +++ b/language/root/domain/context/handler/index.html @@ -1,8 +1,8 @@ -Context Handler | RIDDL DocumentationContext Handler | RIDDL Documentation + -
    +Note that an Entity can define a handler too, but they are different than the handlers defined in a context. See Entity Handler for more details. There are two kinds of handlers as described in the following sections.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +the full API. This allows for modula definition of the API.

    \ No newline at end of file diff --git a/language/root/domain/context/index.html b/language/root/domain/context/index.html index 96188d5ce..1153d2189 100644 --- a/language/root/domain/context/index.html +++ b/language/root/domain/context/index.html @@ -1,11 +1,11 @@ -Context | RIDDL DocumentationContext | RIDDL Documentation + -
    +Contained Definitions Common Types Options A context may define options. Options help the translation tools know what to do with">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +specific to being defined in a context:

    \ No newline at end of file diff --git a/language/root/domain/context/projection/index.html b/language/root/domain/context/projection/index.html index 911a22795..d08cb09bf 100644 --- a/language/root/domain/context/projection/index.html +++ b/language/root/domain/context/projection/index.html @@ -1,8 +1,8 @@ -Projections | RIDDL DocumentationProjections | RIDDL Documentation + -
    +Necessity Projections are necessary since persistent entities use event sourcing which is not a query-friendly data layout since it is merely a sequential event log that indicates what changed. To query this event log one would have to reconstruct the current state from each entity’s set of events which could be exceedingly time-consuming.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +transformed into a more query-friendly format and stored in queriable repository or DB.

    CQRS/ES

    \ No newline at end of file diff --git a/language/root/domain/context/saga/index.html b/language/root/domain/context/saga/index.html index 954470618..7ef3f0ca6 100644 --- a/language/root/domain/context/saga/index.html +++ b/language/root/domain/context/saga/index.html @@ -1,8 +1,8 @@ -Saga | RIDDL DocumentationSaga | RIDDL Documentation + -
    +You have applied the Database per Service pattern. Each service has its own database. Some business transactions, however, span multiple service so you need a mechanism to implement transactions that span services.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/language/root/domain/epic/index.html b/language/root/domain/epic/index.html index a1b350aac..3164af44e 100644 --- a/language/root/domain/epic/index.html +++ b/language/root/domain/epic/index.html @@ -1,5 +1,5 @@ -Epic | RIDDL Documentation -
    +Epic | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/language/root/domain/index.html b/language/root/domain/index.html index 70a300dcd..b65bb3fb4 100644 --- a/language/root/domain/index.html +++ b/language/root/domain/index.html @@ -1,5 +1,5 @@ -Domain | RIDDL Documentation -
    +Domain | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +Trucks and Repairs.

    \ No newline at end of file diff --git a/language/root/domain/streaming/index.html b/language/root/domain/streaming/index.html index f81f81036..9303f3f25 100644 --- a/language/root/domain/streaming/index.html +++ b/language/root/domain/streaming/index.html @@ -1,8 +1,8 @@ -Streaming | RIDDL DocumentationStreaming | RIDDL Documentation + -
    +All you have to do is remember the 3 P’s:">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +can be modeled in RIDDL.
    \ No newline at end of file diff --git a/language/root/domain/streaming/pipe/index.html b/language/root/domain/streaming/pipe/index.html index 279631f01..a05a9d7ae 100644 --- a/language/root/domain/streaming/pipe/index.html +++ b/language/root/domain/streaming/pipe/index.html @@ -1,11 +1,11 @@ -Pipes | RIDDL DocumentationPipes | RIDDL Documentation + -
    +rate - an expected sustained rate of 1000 data points per second partitions - a minimum number of partitions on the data of 7 Data Transmission Type Pipes can transmit any data type that RIDDL can specify.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +case for Kafka.

    \ No newline at end of file diff --git a/language/root/domain/streaming/plant/index.html b/language/root/domain/streaming/plant/index.html index 05ca1b686..f80c155df 100644 --- a/language/root/domain/streaming/plant/index.html +++ b/language/root/domain/streaming/plant/index.html @@ -1,8 +1,8 @@ -Plants | RIDDL DocumentationPlants | RIDDL Documentation + -
    +Joints The purpose of a plant definition is to provide the blueprint for how a set of pipes, processors, and entities are joined together so that data may flow end-to-end.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +

    TBD

    \ No newline at end of file diff --git a/language/root/domain/streaming/processor/index.html b/language/root/domain/streaming/processor/index.html index 11baee525..908bdf9e1 100644 --- a/language/root/domain/streaming/processor/index.html +++ b/language/root/domain/streaming/processor/index.html @@ -1,8 +1,8 @@ -Processors | RIDDL DocumentationProcessors | RIDDL Documentation + -
    +Inlets An inlet statement in the definition of a processor provides the name and data type for an input to the processor. There can be multiple inlets to the processor but each one must have a separate inlet statement.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +adjustments to a sensor’s attenuation based on the temperature.

    \ No newline at end of file diff --git a/language/root/index.html b/language/root/index.html index 1337d51e4..cee7ce205 100644 --- a/language/root/index.html +++ b/language/root/index.html @@ -1,14 +1,14 @@ -Root | RIDDL DocumentationRoot | RIDDL Documentation + -
    +include "other-file" domain foo is { ?">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +down from there.

    \ No newline at end of file diff --git a/privacy-policy/index.html b/privacy-policy/index.html index f3b76b363..acc30c192 100644 --- a/privacy-policy/index.html +++ b/privacy-policy/index.html @@ -1,5 +1,5 @@ -Privacy Policy | RIDDL Documentation -
    +Privacy Policy | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Privacy Policy

    Static Web Site

    This site, https://riddl.tech/ is static. It does not use cookies, has no ability to collect your information, and does not invade your privacy. This -site is merely for documentation that you may read without security concerns.

    \ No newline at end of file +site is merely for documentation that you may read without security concerns.

    \ No newline at end of file diff --git a/reactive-summit/index.html b/reactive-summit/index.html index 4185a352b..129ca4e64 100644 --- a/reactive-summit/index.html +++ b/reactive-summit/index.html @@ -1,14 +1,14 @@ -Reactive Summit | RIDDL DocumentationReactive Summit | RIDDL Documentation + -
    +Please send a link request and a note mentioning Reactive Summit ">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    1. Index
    2. /
    3. Reactive Summit
    \ No newline at end of file +

    Full Slide Deck

    Reid’s LinkedIn Profile

    \ No newline at end of file diff --git a/search/index.html b/search/index.html index ca15ad082..078c903fe 100644 --- a/search/index.html +++ b/search/index.html @@ -1,5 +1,5 @@ -Search Result | RIDDL Documentation -
    +Search Result | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    1. Index
    2. /
    3. Search Result

    Search Result

    \ No newline at end of file +justify-between" itemprop=breadcrumb>
    1. Index
    2. /
    3. Search Result
    Edit page

    Search Result

    \ No newline at end of file diff --git a/tags/index.html b/tags/index.html index 8b09d86d6..74a0ad709 100644 --- a/tags/index.html +++ b/tags/index.html @@ -1,5 +1,5 @@ -Tags | RIDDL Documentation -
    +Tags | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +

    Tags

    \ No newline at end of file diff --git a/tags/page/1/index.html b/tags/page/1/index.html index ef4a60eb6..34ea567ce 100644 --- a/tags/page/1/index.html +++ b/tags/page/1/index.html @@ -1 +1,2 @@ -https://riddl.tech/tags/ \ No newline at end of file +https://riddl.tech/tags/ + \ No newline at end of file diff --git a/tooling/editor-plugins/index.html b/tooling/editor-plugins/index.html index 9b561069a..62e5ceeeb 100644 --- a/tooling/editor-plugins/index.html +++ b/tooling/editor-plugins/index.html @@ -1,8 +1,8 @@ -Getting Ready To Go | RIDDL DocumentationGetting Ready To Go | RIDDL Documentation + -
    +IntelliJ IDEA Plugin VS Code Plugin ">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    1. Index
    2. /
    3. Tooling
    4. /
    5. Getting Ready To Go
    \ No newline at end of file +authors in writing RIDDL:

    \ No newline at end of file diff --git a/tooling/editor-plugins/intellij-plugin/index.html b/tooling/editor-plugins/intellij-plugin/index.html index e59b0cc4d..5bf23f194 100644 --- a/tooling/editor-plugins/intellij-plugin/index.html +++ b/tooling/editor-plugins/intellij-plugin/index.html @@ -1,8 +1,8 @@ -IntelliJ Plugin | RIDDL DocumentationIntelliJ Plugin | RIDDL Documentation + -
    +Like other languages, RIDDL will have an IntelliJ Plugin to do syntax highlighting and error checking to help the author write the language effectively.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    IntelliJ Plugin

    This project has not started yet but has a high priority attached to it.

    Like other languages, RIDDL will have an IntelliJ Plugin to do syntax highlighting and error checking to help the author write the -language effectively.

    \ No newline at end of file +language effectively.

    \ No newline at end of file diff --git a/tooling/editor-plugins/vs-code-plugin/index.html b/tooling/editor-plugins/vs-code-plugin/index.html index 276da368e..4ec6da4f7 100644 --- a/tooling/editor-plugins/vs-code-plugin/index.html +++ b/tooling/editor-plugins/vs-code-plugin/index.html @@ -1,8 +1,8 @@ -VSCode Plugin | RIDDL DocumentationVSCode Plugin | RIDDL Documentation + -
    +Like other languages, RIDDL will have a Visual Studio Code plugin to do syntax highlighting and error checking to help authors write the language effectively.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    VSCode Plugin

    This project has not started yet but has a high priority attached to it.

    Like other languages, RIDDL will have a Visual Studio Code plugin to do syntax highlighting and error checking to help authors -write the language effectively.

    \ No newline at end of file +write the language effectively.

    \ No newline at end of file diff --git a/tooling/index.html b/tooling/index.html index d438e0105..0e0425a6b 100644 --- a/tooling/index.html +++ b/tooling/index.html @@ -1,5 +1,5 @@ -Tooling | RIDDL Documentation -
    +Tooling | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    1. Index
    2. /
    3. Tooling
    \ No newline at end of file +install and use them. There is a subsection for each tool provided, as follows

    \ No newline at end of file diff --git a/tooling/riddlc/build/index.html b/tooling/riddlc/build/index.html index 9c2dc07fc..6bd53d47b 100644 --- a/tooling/riddlc/build/index.html +++ b/tooling/riddlc/build/index.html @@ -1,5 +1,5 @@ -How To Build `riddlc` | RIDDL Documentation -
    +How To Build `riddlc` | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tooling/riddlc/command-line-help/index.html b/tooling/riddlc/command-line-help/index.html index 5dba77911..c15b8ccb1 100644 --- a/tooling/riddlc/command-line-help/index.html +++ b/tooling/riddlc/command-line-help/index.html @@ -1,5 +1,5 @@ -riddlc --help | RIDDL Documentation -
    +riddlc --help | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tooling/riddlc/compilation-phases/index.html b/tooling/riddlc/compilation-phases/index.html index 751b99144..523b296d4 100644 --- a/tooling/riddlc/compilation-phases/index.html +++ b/tooling/riddlc/compilation-phases/index.html @@ -1,8 +1,8 @@ -Compiling RIDDL | RIDDL DocumentationCompiling RIDDL | RIDDL Documentation + -
    +Lexical Analysis This phase parses the raw textual input of the RIDDL sources to make sure it is syntactically correct. As the RIDDL source is analyzed an in-memory model of the RIDDL file known as an abstract syntax tree (AST) is constructed.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +that you wish.

    \ No newline at end of file diff --git a/tooling/riddlc/compilation/index.html b/tooling/riddlc/compilation/index.html index d52bca3fa..b0478f0a1 100644 --- a/tooling/riddlc/compilation/index.html +++ b/tooling/riddlc/compilation/index.html @@ -1,8 +1,8 @@ -Compilation | RIDDL DocumentationCompilation | RIDDL Documentation + -
    +Lexical Analysis Riddl uses the excellent fastparse library by Li Haoyi. This phase parses the raw textual input to make sure it is syntactically correct. From that syntax, an abstract syntax tree (AST) is produced. Incorrect syntax leads to errors without further analysis.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +input model tends to produce output that is flawed or less than useful.

    \ No newline at end of file diff --git a/tooling/riddlc/download-and-use-a-release/index.html b/tooling/riddlc/download-and-use-a-release/index.html index bd5a525f5..524db0935 100644 --- a/tooling/riddlc/download-and-use-a-release/index.html +++ b/tooling/riddlc/download-and-use-a-release/index.html @@ -1,5 +1,5 @@ -Download and install a release | RIDDL Documentation -
    +Download and install a release | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +be different)
  • Put that bin directory in your path
  • Now you can just run “riddlc” from anywhere
  • Some day we will have a packaged installer.
    • \ No newline at end of file diff --git a/tooling/riddlc/from-config-file/index.html b/tooling/riddlc/from-config-file/index.html index 7df95f56f..841b88103 100644 --- a/tooling/riddlc/from-config-file/index.html +++ b/tooling/riddlc/from-config-file/index.html @@ -1,8 +1,8 @@ -riddlc Config File | RIDDL Documentationriddlc Config File | RIDDL Documentation + -
    +# This file contains the input parameters to riddlc for use with `riddlc from` command. # We want to run the "hugo" command in riddlc so that riddl input is converted to input for the hugo web site generator. command = hugo # This block provides options that are common to any command.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    riddlc from path/to/hocon/file/above validate

    This would use the “common” and “validate” sections of the hocon file for configuration and then run the validate command. The file validated is specified by the input-file setting. The common options specify that the validate -command, or any other command supported by the hocon file would:

    \ No newline at end of file +command, or any other command supported by the hocon file would:

    \ No newline at end of file diff --git a/tooling/riddlc/index.html b/tooling/riddlc/index.html index 4a109df48..ce450ccac 100644 --- a/tooling/riddlc/index.html +++ b/tooling/riddlc/index.html @@ -1,5 +1,5 @@ -riddlc | RIDDL Documentation -
    +riddlc | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    1. Index
    2. /
    3. Tooling
    4. /
    5. riddlc
    \ No newline at end of file +justify-between" itemprop=breadcrumb>
    1. Index
    2. /
    3. Tooling
    4. /
    5. riddlc
    Edit page

    riddlc

    This section covers how use the riddlc tool.

    \ No newline at end of file diff --git a/tooling/riddlc/install/index.html b/tooling/riddlc/install/index.html index c4dff2dce..173954c8f 100644 --- a/tooling/riddlc/install/index.html +++ b/tooling/riddlc/install/index.html @@ -1,5 +1,5 @@ -Installing `riddlc` | RIDDL Documentation -
    +Installing `riddlc` | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +

    TBD. Some day we will have a native installer for each platform.

    \ No newline at end of file diff --git a/tooling/riddlc/translation/hugo/index.html b/tooling/riddlc/translation/hugo/index.html index 9ebadfa12..6375e3425 100644 --- a/tooling/riddlc/translation/hugo/index.html +++ b/tooling/riddlc/translation/hugo/index.html @@ -1,5 +1,5 @@ -Hugo Docs | RIDDL Documentation -
    +Hugo Docs | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +generator. See Hugo Documentation for details on how to

    \ No newline at end of file diff --git a/tooling/riddlc/translation/index.html b/tooling/riddlc/translation/index.html index 8cac00219..3d3febee5 100644 --- a/tooling/riddlc/translation/index.html +++ b/tooling/riddlc/translation/index.html @@ -1,5 +1,5 @@ -Translation | RIDDL Documentation -
    +Translation | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +output generated.
    \ No newline at end of file diff --git a/tooling/riddlc/translation/options/index.html b/tooling/riddlc/translation/options/index.html index 6017d9b9f..59ceb9a23 100644 --- a/tooling/riddlc/translation/options/index.html +++ b/tooling/riddlc/translation/options/index.html @@ -1,11 +1,11 @@ -riddlc options | RIDDL Documentationriddlc options | RIDDL Documentation + -
    +-h (–help) Causes riddlc to print out help and usage information and exit.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tooling/riddlc/using-the-get-riddlc-action/index.html b/tooling/riddlc/using-the-get-riddlc-action/index.html index e42b92814..7a366de7f 100644 --- a/tooling/riddlc/using-the-get-riddlc-action/index.html +++ b/tooling/riddlc/using-the-get-riddlc-action/index.html @@ -1,5 +1,5 @@ -Using riddlc/actions/get-riddlc@main | RIDDL Documentation -
    +Using riddlc/actions/get-riddlc@main | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +

    GitHub actions and workflows are documented at this link

    \ No newline at end of file diff --git a/tooling/sbt-riddl/index.html b/tooling/sbt-riddl/index.html index 8d9600514..47d8893b8 100644 --- a/tooling/sbt-riddl/index.html +++ b/tooling/sbt-riddl/index.html @@ -1,5 +1,5 @@ -sbt-riddl | RIDDL Documentation -
    +sbt-riddl | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +used in subsequent compilation steps.

    \ No newline at end of file diff --git a/tutorial/index.html b/tutorial/index.html index 0191ccc43..2896f611d 100644 --- a/tutorial/index.html +++ b/tutorial/index.html @@ -1,5 +1,5 @@ -Tutorial | RIDDL Documentation -
    +Tutorial | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +found here.

    Read more here

    \ No newline at end of file diff --git a/tutorial/rbbq/backoffice/index.html b/tutorial/rbbq/backoffice/index.html index 1f784fd25..40c5f785e 100644 --- a/tutorial/rbbq/backoffice/index.html +++ b/tutorial/rbbq/backoffice/index.html @@ -1,5 +1,5 @@ -Back Office | RIDDL Documentation -
    +Back Office | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    1. Index
    2. /
    3. Tutorial
    4. /
    5. Example
    6. /
    7. Back Office

    Back Office

    // insert https://github.com/reactific/riddl-examples/blob/main/src/riddl/ReactiveBBQ/backoffice/domain.riddl
-
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tutorial/rbbq/corporate/index.html b/tutorial/rbbq/corporate/index.html index cdd5b0bf5..a3f7274b0 100644 --- a/tutorial/rbbq/corporate/index.html +++ b/tutorial/rbbq/corporate/index.html @@ -1,5 +1,5 @@ -Corporate | RIDDL Documentation -
    +Corporate | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Corporate

    // insert https://github.com/reactific/riddl-examples/blob/main/src/riddl/ReactiveBBQ/corporate/domain.riddl
-
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tutorial/rbbq/index.html b/tutorial/rbbq/index.html index 9371138a7..5c69fc298 100644 --- a/tutorial/rbbq/index.html +++ b/tutorial/rbbq/index.html @@ -1,5 +1,5 @@ -Example | RIDDL Documentation -
    +Example | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +each with an explanation page as follows:

    \ No newline at end of file diff --git a/tutorial/rbbq/reactivebbq/index.html b/tutorial/rbbq/reactivebbq/index.html index 0394accb0..889e4ec69 100644 --- a/tutorial/rbbq/reactivebbq/index.html +++ b/tutorial/rbbq/reactivebbq/index.html @@ -1,8 +1,8 @@ -Reactive BBQ | RIDDL DocumentationReactive BBQ | RIDDL Documentation + -
    +At this top level of definition we can see that a single domain named ReactiveBBQ represents the entire enterprise. The details of that top level domain is abstracted away via three include statements within its body, one for each of the subdomains:">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +statements within its body, one for each of the subdomains:

    \ No newline at end of file diff --git a/tutorial/rbbq/restaurant/index.html b/tutorial/rbbq/restaurant/index.html index 27c3c445b..54fca0c6e 100644 --- a/tutorial/rbbq/restaurant/index.html +++ b/tutorial/rbbq/restaurant/index.html @@ -1,5 +1,5 @@ -Restaurant | RIDDL Documentation -
    +Restaurant | RIDDL Documentation +
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Restaurant

    // insert https://github.com/reactific/riddl-examples/blob/main/src/riddl/ReactiveBBQ/restaurant/domain.riddl
-
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tutorial/rbbq/scenario/bartender/index.html b/tutorial/rbbq/scenario/bartender/index.html index 58d5e0bb0..de94fdfcf 100644 --- a/tutorial/rbbq/scenario/bartender/index.html +++ b/tutorial/rbbq/scenario/bartender/index.html @@ -1,11 +1,11 @@ -Bartender | RIDDL DocumentationBartender | RIDDL Documentation + -
    +I also mix drink orders for the servers in the restaurant. The servers deliver those drinks. I just get them ready and leave them on a tray with the table number so the servers know where they go.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Bartender

    What is your role in the restaurant?

    I take drink orders at the bar and entertain the guests. I mix the drinks and take them to the customers when they are ready. When the customer is done for the day I help them settle their tab.

    I also mix drink orders for the servers in the restaurant. The servers deliver those drinks. I just get them ready and leave them on a tray with the table number so the servers know where they go.

    At the end of a shift I cash out with the restaurant and take my tips.

    What challenges do you face?

    Sometimes drink orders will sit for a really long time. When a drink is ordered a ticket prints out at my station and I usually make it right away. But the servers get busy, or they forget to check for the order. The drink ends up sitting on the counter for a while before they are able to come and get it. This means the ice is melting and it can really ruin a good drink.

    It would be nice if there was a way to let the server know that their order is ready. Sometimes I end up looking around and trying to signal them if the drink has been sitting for a while, but they aren’t always easy to track down because they might be busy talking to customers. It would be nice if there was some way to get someone else to deliver the drinks. I would do it, but I am not allowed to leave the bar unattended.

    Bartender’s Key Details -

    • Bartender takes drink orders at the bar.
    • Bartender prepares drinks for customers at the bar.
    • Bartender delivers drink orders to customers at the bar.
    • Bartender collects payments for the customers at the bar.
    • Bartender prepares drinks for tables to be taken out be the servers.
    • Collect tips, similar to the server.
    • Would like a way to notify servers when something is ready.
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tutorial/rbbq/scenario/ceo/index.html b/tutorial/rbbq/scenario/ceo/index.html index 78b2e6d93..afea5a883 100644 --- a/tutorial/rbbq/scenario/ceo/index.html +++ b/tutorial/rbbq/scenario/ceo/index.html @@ -1,8 +1,8 @@ -CEO of Reactive BBQ | RIDDL DocumentationCEO of Reactive BBQ | RIDDL Documentation + -
    +Reactive BBQ is a family restaurant with 500 locations across 20 countries. We’re open for breakfast, lunch and supper. Our specialty at Reactive BBQ is our award winning Reactive Ribs, but we are also well known for our tender steaks and our slow roasted chicken. We take traditional BBQ flavours and give them a bit of a spicy punch. The customer experience at each Reactive BBQ should have the same high level of quality across the globe.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    CEO of Reactive BBQ

    How would you describe your restaurants?

    Reactive BBQ is a family restaurant with 500 locations across 20 countries. We’re open for breakfast, lunch and supper. Our specialty at Reactive BBQ is our award winning Reactive Ribs, but we are also well known for our tender steaks and our slow roasted chicken. We take traditional BBQ flavours and give them a bit of a spicy punch. The customer experience at each Reactive BBQ should have the same high level of quality across the globe.

    What challenges do you face?

    The challenge is that our original system was designed for one restaurant, and as more were opened, we started moving into the cloud. We started by moving inventory management into the cloud. Then we moved the customers facing areas: reservations, ordering etc. into the same application. We created a website on top of this so that customers can place orders for pickup or delivery, but they can also make reservations online.

    As we add more locations, the system becomes unresponsive during peak hours as it seems to be struggling to keep up with all the reservations, the servers entering orders, orders being filled, payments, all of these drag everything down to a crawl. Staff gets frustrated, customers even more so, it can take 30 seconds to make a reservation, or enter an order.

    The Operations team attempted to address the peak time performance issue by adding more instances of the application in the cloud, but this turned out to be quite expensive, and we still see a noticeable lag in response times during peak hours.

    Another issue is that our application seems to be brittle. When one thing goes wrong, it seems like everything else goes wrong at the same time. I keep hearing reports of outages across the board. And these outages have a huge impact on our business. In the early days, when a problem happened, it affected a single restaurant. But now that we are in the cloud, when the application becomes unavailable it can affect many restaurants or even all of them.

    We have been forced to limit certain activities during certain times of the day. For example, during the lunch hour on the east coast we aren’t allowed to generate certain kinds of reports. The same applies for the west coast. As our operation expands into more time zones, it is become harder to find the right time to do these reports. Ideally doing an inventory report during the lunch rush shouldn’t make the system crawl.

    Another issue is upgrades. Every time we want to upgrade the software we have to take the whole system offline. This is also affected by things like the east coast lunch rush. So again we have to look for specific windows during the day to deploy. Those windows are getting smaller, and the deployments are taking longer. Sometimes when we do an upgrade something goes wrong and the system is unavailable during the times we need it the most. This gets very expensive and very annoying.

    We have been wanting to implement a loyalty program that requires tracking data about our customers, but our development team tells us this would be a “major refactor”, and that sounds expensive and risky. I don’t really understand the details, but it feels like adding a loyalty program to do the tracking shouldn’t be that big of a deal.

    I wanted to implement a new electronic menu for the restaurants. You know, with the tablets on the tables? I thought it would be more environmentally friendly than printing new menus every month. It would also help us follow the trends. Anyway, that apparently was problematic as well. The system that deals with the online menu is really tightly tied up with the fact that it is online and deliveries and all that. I don’t really understand the details, but apparently adapting it to work in the restaurant is apparently going to be a lot of work. I would also like to put screens in the kitchen so we could get rid of paper completely.

    CEO’s Key Details -

    • 500+ Locations
    • Existing Cloud Infrastructure
    • Online Delivery/Pickup Orders, Reservations
    • Experiencing too much downtime
      • Due to upgrades or failures
    • System responds slowly
    • Outages can be very expensive
    • Actions being taken to “work around” the problems with the system
    • Want to implement a loyalty program but it’s risky
    • Want to implement electronic menus but it is also risky
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tutorial/rbbq/scenario/chef/index.html b/tutorial/rbbq/scenario/chef/index.html index 91769a04c..f17fc8ce6 100644 --- a/tutorial/rbbq/scenario/chef/index.html +++ b/tutorial/rbbq/scenario/chef/index.html @@ -1,14 +1,14 @@ -Chef | RIDDL DocumentationChef | RIDDL Documentation + -
    +I think the worst thing is when the system that prints our orders goes haywire. Sometimes the system crashes and orders get lost.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Chef

    What is your role in the restaurant?

    I oversee the entire kitchen and all of its staff. I source local ingredients required to prepare our menu items. The menu is decided on monthly and distributed via email. I inspect all prepared orders that leave the kitchen.

    What challenges do you face?

    I think the worst thing is when the system that prints our orders goes haywire. Sometimes the system crashes and orders get lost. While it is down we don’t know what needs to be made. The servers have to resort to handwritten tickets and it’s sometimes difficult to read their writing. Some of it is really just gibberish. It results in a lot of orders getting missed or getting made improperly.

    The servers complain a lot about the system being slow, but we don’t really see that in the kitchen. Once they enter an order it usually prints out right away as long as the system is working.

    Chef’s Key Details -

    • Chef sources local ingredients for the menu.
    • Chef inspects all orders that leave the kitchen.
    • Orders get lost when the system fails.
    • Handwritten tickets are a pain.
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tutorial/rbbq/scenario/cook/index.html b/tutorial/rbbq/scenario/cook/index.html index 9c4e1f35a..b164a07f1 100644 --- a/tutorial/rbbq/scenario/cook/index.html +++ b/tutorial/rbbq/scenario/cook/index.html @@ -1,8 +1,8 @@ -Cook | RIDDL DocumentationCook | RIDDL Documentation + -
    +Depending on the day, I work at different stations in the kitchen. The chef tells me where I will be working for that day. I prepare orders according to the tickets that get printed out at my station. Once an order is ready, I take it over to a station where we gather all the pieces of that order. The chef then approves it and we notifiy the server that their order is ready.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Cook

    What is your role in the restaurant?

    Depending on the day, I work at different stations in the kitchen. The chef tells me where I will be working for that day. I prepare orders according to the tickets that get printed out at my station. Once an order is ready, I take it over to a station where we gather all the pieces of that order. The chef then approves it and we notifiy the server that their order is ready.

    What challenges do you face?

    Handwritten tickets. Man do I hate those things. We have this one server that writes in this horrible chicken scratch. Every time he brings me these tickets, I have to get her to explain to me what she has written. It’s just awful.

    Then there is the server’s attitudes. It’s pretty good most of the time, but when things get busy they start to get really annoying. When they get frustrated they kind of take it out on us in the kitchen. They start yelling about their orders taking too long. I try to explain to them that there are other orders that came first and I have to do them before I can get to theirs, but it doesn’t help. They end up storming off. I hear them talking sometimes like it’s our fault somehow.

    Cook’s Key Details -

    • Printed Ticket provide details on orders to be prepared.
    • Handwritten tickets are a pain.
    • Servers are frustrated.
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tutorial/rbbq/scenario/deliverydriver/index.html b/tutorial/rbbq/scenario/deliverydriver/index.html index 9f646a8da..a82bbc8c5 100644 --- a/tutorial/rbbq/scenario/deliverydriver/index.html +++ b/tutorial/rbbq/scenario/deliverydriver/index.html @@ -1,8 +1,8 @@ -Delivery Driver | RIDDL DocumentationDelivery Driver | RIDDL Documentation + -
    +I deliver for five locations around the city. We don’t get a lot of deliveries. We aren’t a pizza place after all. but our wings and ribs are popular delivery options. I am on call for each of the delivery locations. If one of them gets a delivery, I get a notification on my phone. I go pick up the food from the location nearest the customer.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Delivery Driver

    What is your role in the restaurant?

    I deliver for five locations around the city. We don’t get a lot of deliveries. We aren’t a pizza place after all. but our wings and ribs are popular delivery options. I am on call for each of the delivery locations. If one of them gets a delivery, I get a notification on my phone. I go pick up the food from the location nearest the customer. Then I drive to the customer, and deliver their food. I collect their payment if necessary. Sometimes they pay online. In that case I don’t have to do much, just drop off the food.

    What challenges do you face?

    You mean other than traffic and customers annoyed with the delivery times? I think the app they give me is probably my biggest headache. I have this app on my phone. When I get a delivery it notifies me. It gives me all the details about the order and the customer. I also have a dongle that I attach to my phone that allow me to collect credit/debit payments.

    The problem is that sometimes it doesn’t work. I will be on the way to a customer site when suddenly it just stops. I get some error like “unable to communicate with server” or something. When that happens I lose everything. I don’t have access to the customer address or their order. Thankfully they always print that information out on the bill before the delivery so I can still use that. But then when I go to collect the payment I end up having to use one of those old credit card swipe machines. The manual ones that take an imprint of the card. That doesn’t work if the customer planned to pay with debit though. In those cases I am out of luck.

    Apparently they are going to start offering customer loyalty cards as well. They tell me that those will go through the same app. That just sounds like more headache. So now when the system goes down I am going to have to write down the customer’s loyalty number, and then enter it when manually when the system comes back up.

    Delivery Driver’s Key Details -

    • Driver gets notifications through the app on their phone.
    • Driver picks up orders and delivers them to the customer.
    • Driver collects payments.
    • Workarounds for unreliable software in the form of printed receipts.
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tutorial/rbbq/scenario/headchef/index.html b/tutorial/rbbq/scenario/headchef/index.html index 6db74743e..5edce30d4 100644 --- a/tutorial/rbbq/scenario/headchef/index.html +++ b/tutorial/rbbq/scenario/headchef/index.html @@ -1,8 +1,8 @@ -Corporate Head Chef | RIDDL DocumentationCorporate Head Chef | RIDDL Documentation + -
    +Corporate wants each restaurant to have a consistent experience. My job is to create new recipes to be included in the menu. I spend a lot of time trying out different ingredients and flavours to try to get the right balance for our menu. I have to be careful to stick to ingredients that we can buy in sufficient quantities. Most people think that a restaurant like ours prepares everything from scratch.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Corporate Head Chef

    What is your role in the restaurant?

    Corporate wants each restaurant to have a consistent experience. My job is to create new recipes to be included in the menu. I spend a lot of time trying out different ingredients and flavours to try to get the right balance for our menu. I have to be careful to stick to ingredients that we can buy in sufficient quantities. Most people think that a restaurant like ours prepares everything from scratch. Sometimes we do, but a lot of our stuff is bought premade in bulk and then shipped to the restaurants. Our Reactive BBQ sauce is a perfect example. Very few people know what goes into the sauce. Even the companies we get to prepare it don’t have all the details.

    Once I have a new dish figured out I talk to the marketing team. They work on preparing a nice description of the dish. We also have a food photographer so I work with him to make sure that the dish looks nice and is presentable for his photos.

    What challenges do you face?

    Well, as I mentioned there is the issues with sourcing ingredients. It can be a tricky business with all of the regions we have restaurants in. That’s part of the reason why so many things have to be shipped from our warehouses. Some of our ingredients are sourced locally, but not all of them.

    We have these crazy processes around updating the actual menus. We can’t just do it whenever we want. Menus are only updated once a month. That makes sense because there are printer costs and distribution issues we have to think about. Basically once a month, after everything is prepared, I send an email out to all the restaurants with new menu items and recipes. But then we have to coordinate with the printers to make sure they get hard copies delivered in time. And then we have to also coordinate with the website to make sure they are up to date. It becomes a bit of a hassle. Basically near the end of every month we have this flurry of activity to get everything prepared.

    Head Chef’s Key Details -

    • Corporate Chef updates the menu once a month.
    • Corporate Chef works with photographer on menu photographs.
    • Corporate Chef deals with supply chain for the restaurants.
    • Menu updates must be coordinated with printing and website.
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tutorial/rbbq/scenario/host/index.html b/tutorial/rbbq/scenario/host/index.html index 70e9611a9..0d330dc7d 100644 --- a/tutorial/rbbq/scenario/host/index.html +++ b/tutorial/rbbq/scenario/host/index.html @@ -1,8 +1,8 @@ -Host | RIDDL DocumentationHost | RIDDL Documentation + -
    +I answer phones and record reservations. I also greet and seat guests as they arrive at the restaurant. Guests can either call, or use the website to make reservations, so it is necessary for me to consult the system before I seat customers. I also need to update the reservations system when I seat customers so that someone online can’t reserve the same table.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Host

    What is your role in the restaurant?

    I answer phones and record reservations. I also greet and seat guests as they arrive at the restaurant. Guests can either call, or use the website to make reservations, so it is necessary for me to consult the system before I seat customers. I also need to update the reservations system when I seat customers so that someone online can’t reserve the same table.

    What challenges do you face?

    I think the biggest problem I have is the reservations system. It seems like it is never working properly. Sometimes I try to add a reservation and it takes forever. I have customers lined up waiting for their tables and I don’t have time to be dealing with the slow software. Or I might go to look up the reservation for a customer and it takes so long to find it. The customers get frustrated and I am always apologizing to them for the slow software. Sometimes, after waiting forever for the information to come back, the system just crashes and I get nothing. Then it takes minutes or in rare cases hours for it to come back up. In the meantime I am struggling to figure out who is supposed to have a reservation and who isn’t.

    I have started printing out all the reservations periodically during the day. It helps to speed things up because I don’t have to use the software. But it doesn’t work for more recent reservations, so I end up looking at the print outs first and then only going to the software if I don’t find the person on the sheet.

    Host’s Key Details -

    • Host takes reservations in person or via phone
    • Reservations can also be made online
    • Host seats reservations as well as walk ins.
    • Reservation system is unresponsive
    • System often fails
    • Printouts being used to deal with the failures of the software
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tutorial/rbbq/scenario/index.html b/tutorial/rbbq/scenario/index.html index 1f9dd74dd..8fc7ceb88 100644 --- a/tutorial/rbbq/scenario/index.html +++ b/tutorial/rbbq/scenario/index.html @@ -1,8 +1,8 @@ -Reactive BBQ Case Study | RIDDL DocumentationReactive BBQ Case Study | RIDDL Documentation + -
    +As you might guess from the name, Reactive BBQ is a restaurant chain that serves spicy (reactive!">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage
    \ No newline at end of file +in order to identify the issues.

    \ No newline at end of file diff --git a/tutorial/rbbq/scenario/onlinecustomer/index.html b/tutorial/rbbq/scenario/onlinecustomer/index.html index 7656fdc9c..352b308f0 100644 --- a/tutorial/rbbq/scenario/onlinecustomer/index.html +++ b/tutorial/rbbq/scenario/onlinecustomer/index.html @@ -1,8 +1,8 @@ -Online Customer | RIDDL DocumentationOnline Customer | RIDDL Documentation + -
    +Well, I go to the website and they have their menu there. I have a look at the menu and decide what I want. The menu is organized into different sections, like lunch, dinner, appetizers, dessert, that sort of thing. The menu online isn’t identical to what I get in the restaurant, but it’s pretty close. I have also done it through the phone app they have.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Online Customer

    Describe how you place an order online with Reactive BBQ

    Well, I go to the website and they have their menu there. I have a look at the menu and decide what I want. The menu is organized into different sections, like lunch, dinner, appetizers, dessert, that sort of thing. The menu online isn’t identical to what I get in the restaurant, but it’s pretty close. I have also done it through the phone app they have.

    As I find things that I want, I add them to my order. Then when I have everything I want, I checkout.

    To checkout I have to give them some information, like the delivery address, my phone number, that sort of thing. I also have to give them my credit card information so that I can pay for it. I order pretty often though, so they have all of that stuff on file already. I just enter my username and password. Once that is done, I finish the order and then I have to wait.

    And what happens when your food is delivered?

    The driver brings the food to the door. They hand me the food. I usually pay online. I love that when they come to the door, I don’t have to give them money. I can enter a tip online too so that I don’t have to give them anything, but it always feels a bit weird to tip them when they haven’t delivered the food yet. If I have cash I will often pay for the food online but then give them the tip in person. I live pretty far away and it’s a bit of a drive for them, so I usually tip them pretty well. I like to see their smile when I give it to them in person.

    Do you ever order pickup?

    Sometimes. I order pickup once in a while and just grab it on my way home from work. I can still order online so I usually do that, and then I just choose pickup instead of delivery. Sometimes, if I am away from my computer, I will just phone them and order something instead.

    Do you ever have trouble ordering online?

    Sometimes. Their website and app aren’t always working. Or if it is working it can be really slow. I don’t mind waiting when it’s slow, unless I am in a hurry or really hungry. But when it doesn’t work at all, I usually just don’t bother. When that happens I will usually just order from the other place down the street. The food isn’t as good, and their website is kind of hard to use, but it gets the job done in a pinch.

    Have you ever used the online reservation system?

    I have used it once or twice. I usually eat at home so I don’t use it that often. But it has been okay when I have used it. I don’t get to pick specific tables or anything. I just give them a few details about what I want, like how many people, whether I want a booth, that sort of thing.

    Online Customer’s Key Details -

    • Customer adds menu items to their order through the website/app.
    • Customer checks out when they have completed their order.
    • Customer enters delivery or pickup information.
    • Customer authorizes payment and tip through the website/app.
    • Customer makes reservations through the website/app.
    • Website/app doesn’t always work, forcing customer to go elsewhere.
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tutorial/rbbq/scenario/server/index.html b/tutorial/rbbq/scenario/server/index.html index ec6417daa..6d688e8ba 100644 --- a/tutorial/rbbq/scenario/server/index.html +++ b/tutorial/rbbq/scenario/server/index.html @@ -1,11 +1,11 @@ -Server | RIDDL DocumentationServer | RIDDL Documentation + -
    +When the guest is finished, I present the bill and settle at the table.">
    RIDDL Documentation
    Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

    Server

    What is your role in the restaurant?

    I greet guests at their table, help them understand the menu and make recommendations, then take their food and drink orders. After taking their order I input it into our computer system. When the order is ready I pick it up from the kitchen or bar and deliver it to the table.

    When the guest is finished, I present the bill and settle at the table. At the end of the shift I pay out my cash bills to the restaurant, bundle and submit my receipts and collect my tips.

    How do you know which prepared order from the kitchen/bar is for which table?

    Orders are input into the computer system with the table number, the prepared order is presented with a printout including the table number.

    How do you settle a bill at the table?

    Guests can pay with cash or card.

    How do you track how much you’ve made in tips for a shift?

    Our computer system keeps track of that for me and gives me a total at the end of the shift.

    What challenges do you face?

    During peak times things can get a little hectic. Entering orders seems to take longer when we get busy. We have a limited number of computer terminals to enter the information into, so as things slow down the other servers start to line up to enter their orders. We have asked for more terminals, but apparently they are really expensive so they won’t give us more.

    Some of us have tried going around the system and just asking the kitchen to start making something before we enter the order, but the cooks really don’t like when we do that. They say it’s too hard for them to keep track so they want us to use the computer.

    Server’s Key Details -

    • Server enters orders into the system.
    • Server collects orders from the kitchen and delivers it to the table.
    • Server delivers bills to the tables and collects payments.
    • Server helps customers to understand the menu choices.
    • Software tracks tips etc.
    • System slows down when it’s busy.
    • Servers bottleneck on using the computers.
    • Kitchen doesn’t like servers working around the system.
    \ No newline at end of file +
    \ No newline at end of file