From 52a3e2687a8b1284b8fa3b657fbdaa70dfe1472a Mon Sep 17 00:00:00 2001 From: Michael Hedgpeth Date: Tue, 26 Nov 2024 09:44:30 -0700 Subject: [PATCH 1/6] Clarified experimental nature of crux in its own section, which states the path to 1.0. --- docs/src/overview.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/src/overview.md b/docs/src/overview.md index fff86614b..751fa2476 100644 --- a/docs/src/overview.md +++ b/docs/src/overview.md @@ -1,6 +1,6 @@ # Overview -Crux is an **experimental** approach to building cross-platform applications +Crux is an approach to building cross-platform applications with better testability, higher code and behavior reuse, better safety, security, and more joy from better tools. @@ -66,7 +66,7 @@ will result in build failures in the Shell. ## Goals -We set out to prove this architecture to find a better way of building apps +We set out to find a better way of building apps across platforms. You can read more [about our motivation](./motivation.md). The overall goals of Crux are to: @@ -78,3 +78,20 @@ overall goals of Crux are to: - Separate the behavior from the look and feel and interaction design - Use the native UI tool kits to create user experience that is the best fit for a given platform + +## Path to 1.0 + +Crux is used in production apps today, at least one quite large one. In that sense +we consider it production ready. However, to truly be at 1.0 with a more stable +API, we will take the following steps: + +* Improved documentation, code examples, and example apps for newcomers +* Improved onboarding experience, with less boilerplate code that end users have + to deal with +* Better FFI code generation to enable support for more Shells (e.g. .NET, + Flutter) which will also enable Desktop apps in Windows +* Revised capabilities and effects to allow + for [app composition](./guide/composing.md) in larger apps + +Until then, we hope you will work with us on the rough edges, and factor in +frequent API updates as we evolve. From 104361953ef9cf3c5ae32363df313b1d28cf2072 Mon Sep 17 00:00:00 2001 From: Michael Hedgpeth Date: Sat, 7 Dec 2024 07:12:21 -0700 Subject: [PATCH 2/6] Update docs/src/overview.md Co-authored-by: Viktor Charypar --- docs/src/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/overview.md b/docs/src/overview.md index 751fa2476..9dc5b645e 100644 --- a/docs/src/overview.md +++ b/docs/src/overview.md @@ -1,6 +1,6 @@ # Overview -Crux is an approach to building cross-platform applications +Crux is a framework for building cross-platform applications with better testability, higher code and behavior reuse, better safety, security, and more joy from better tools. From 526e88f43be501abd13d3ca42eed50d9f9e7c2ce Mon Sep 17 00:00:00 2001 From: Michael Hedgpeth Date: Sat, 7 Dec 2024 07:12:43 -0700 Subject: [PATCH 3/6] Update docs/src/overview.md Co-authored-by: Viktor Charypar --- docs/src/overview.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/overview.md b/docs/src/overview.md index 9dc5b645e..061ce5b3b 100644 --- a/docs/src/overview.md +++ b/docs/src/overview.md @@ -81,9 +81,9 @@ overall goals of Crux are to: ## Path to 1.0 -Crux is used in production apps today, at least one quite large one. In that sense -we consider it production ready. However, to truly be at 1.0 with a more stable -API, we will take the following steps: +Crux is used in production apps today, and we consider it production ready. However, we still have a number of things to work on to call it 1.0, with a stable API, and other things one would expect from a mature framework. + +Below is a list of some of the things we know we want to do before 1.0: * Improved documentation, code examples, and example apps for newcomers * Improved onboarding experience, with less boilerplate code that end users have From 95c4345f9578b89179f7ffb9c030c8fd7ed919a6 Mon Sep 17 00:00:00 2001 From: Michael Hedgpeth Date: Wed, 18 Dec 2024 10:38:33 -0700 Subject: [PATCH 4/6] Update docs/src/overview.md Co-authored-by: Viktor Charypar --- docs/src/overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/overview.md b/docs/src/overview.md index 061ce5b3b..ab41a8a56 100644 --- a/docs/src/overview.md +++ b/docs/src/overview.md @@ -93,5 +93,5 @@ Below is a list of some of the things we know we want to do before 1.0: * Revised capabilities and effects to allow for [app composition](./guide/composing.md) in larger apps -Until then, we hope you will work with us on the rough edges, and factor in -frequent API updates as we evolve. +Until then, we hope you will work with us on the rough edges, and adapt to the necessary +API updates as we evolve. We strive to minimise the impact of changes as much as we can, but before 1.0, some breaking changes will be unavoidable. From 44afda207add2438ea705378409ebc737088dba9 Mon Sep 17 00:00:00 2001 From: Michael Hedgpeth Date: Wed, 18 Dec 2024 10:38:43 -0700 Subject: [PATCH 5/6] Update docs/src/overview.md Co-authored-by: Viktor Charypar --- docs/src/overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/overview.md b/docs/src/overview.md index ab41a8a56..e70ba942e 100644 --- a/docs/src/overview.md +++ b/docs/src/overview.md @@ -88,8 +88,8 @@ Below is a list of some of the things we know we want to do before 1.0: * Improved documentation, code examples, and example apps for newcomers * Improved onboarding experience, with less boilerplate code that end users have to deal with -* Better FFI code generation to enable support for more Shells (e.g. .NET, - Flutter) which will also enable Desktop apps in Windows +* Better FFI code generation to enable support for more languages (e.g. C#, Dart, even C++...) + and in trurn more Shells (e.g. .NET, Flutter) which will also enable Desktop apps for Windows * Revised capabilities and effects to allow for [app composition](./guide/composing.md) in larger apps From eb0a5e7bf5a4543501a31d54f18b92b02571128d Mon Sep 17 00:00:00 2001 From: Michael Hedgpeth Date: Wed, 18 Dec 2024 10:39:01 -0700 Subject: [PATCH 6/6] Update docs/src/overview.md Co-authored-by: Viktor Charypar --- docs/src/overview.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/src/overview.md b/docs/src/overview.md index e70ba942e..b41bfa439 100644 --- a/docs/src/overview.md +++ b/docs/src/overview.md @@ -90,8 +90,9 @@ Below is a list of some of the things we know we want to do before 1.0: to deal with * Better FFI code generation to enable support for more languages (e.g. C#, Dart, even C++...) and in trurn more Shells (e.g. .NET, Flutter) which will also enable Desktop apps for Windows -* Revised capabilities and effects to allow - for [app composition](./guide/composing.md) in larger apps +* Revised capabilities and effects to allow for better, more natural + [app composition](./guide/composing.md) in larger apps, for composing capabilities, + and generally for a more ergonomic effect API overall Until then, we hope you will work with us on the rough edges, and adapt to the necessary API updates as we evolve. We strive to minimise the impact of changes as much as we can, but before 1.0, some breaking changes will be unavoidable.