Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarified experimental nature of crux in its own section, which state… #288

Merged
merged 6 commits into from
Dec 30, 2024
Merged

Clarified experimental nature of crux in its own section, which state… #288

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
52a3e26
Clarified experimental nature of crux in its own section, which state…
mhedgpeth Nov 26, 2024
1043619
Update docs/src/overview.md
mhedgpeth Dec 7, 2024
526e88f
Update docs/src/overview.md
mhedgpeth Dec 7, 2024
95c4345
Update docs/src/overview.md
mhedgpeth Dec 18, 2024
44afda2
Update docs/src/overview.md
mhedgpeth Dec 18, 2024
eb0a5e7
Update docs/src/overview.md
mhedgpeth Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions docs/src/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

Crux is an **experimental** 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.

Expand Down Expand Up @@ -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:

Expand All @@ -78,3 +78,21 @@ 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, 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
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 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.
Loading