Clarified experimental nature of crux in its own section, which state… #288
Conversation
…s the path to 1.0.
|
I was reading the same thread and you mentioned updating the docs for newcomers, I've been using chatgpt to help wrap my head around how crux works and I found it easier to understand than the current docs. Here's a partial chat history, perhaps this part of this could be used: https://chatgpt.com/share/674b2e9d-323c-800f-996a-3b80d1fe8a91 |
| * Better FFI code generation to enable support for more Shells (e.g. .NET, | ||
| Flutter) which will also enable Desktop apps in Windows |
There was a problem hiding this comment.
| * 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 |
There was a problem hiding this comment.
| * 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 factor in | ||
| frequent API updates as we evolve. |
There was a problem hiding this comment.
| 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. |
|
@fraschm1998 thanks for that! I enjoed reading it, the robot analogy is great 😄 Definitely some analogies and explanations worth stealing in that conversation. |
|
Some of ChatGPT's ... chat :) about when to send an event in a coroutine and when to call it synchronously are not quite right I don't think, but they point to a missing piece of documentation to write - how the shells should deal with concurrency and how the core fits in. |
Co-authored-by: Viktor Charypar <[email protected]>
Co-authored-by: Viktor Charypar <[email protected]>
|
@charypar thanks for the feedback! I accepted your suggestions. I believe that puts my PR in an acceptable state. |
|
@mhedgpeth There's about three more suggestions to get in unless you don't agree with those. Let me know. Other than that I'm happy to merge this. |
…s the path to 1.0.
As I read through the docs, I was curious as to what made the software experimental. When I asked on Zulip, I learned that the app is used in production, and that the experimental nature of it is really related to its API and use cases.
So I clarified that in the topic, to hopefully make it easier for people to onboard.
In addition, when looking at this, one early problem I had with crux is the lack of Windows Desktop support, and a few hours of research later, I realized that it would be super early and barely an inconvenience with C#/WinUI3 or WPF/PInvoke - it just needs to be done. So I included that callout to hopefully help people who were thinking about crux for the first time.