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.

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

Conversation

mhedgpeth
Copy link
Contributor

…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.

@fraschm1998
Copy link

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

Copy link
Member

@charypar charypar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making a start on this! Sorry it took me so long to get to it. I've suggested some minor wording changes, please let me know if you're happy with them.

docs/src/overview.md Outdated Show resolved Hide resolved
docs/src/overview.md Outdated Show resolved Hide resolved
docs/src/overview.md Outdated Show resolved Hide resolved
docs/src/overview.md Outdated Show resolved Hide resolved
docs/src/overview.md Outdated Show resolved Hide resolved
@charypar
Copy link
Member

charypar commented Dec 6, 2024

@fraschm1998 thanks for that! I enjoed reading it, the robot analogy is great 😄 Definitely some analogies and explanations worth stealing in that conversation.

@charypar
Copy link
Member

charypar commented Dec 6, 2024

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.

mhedgpeth and others added 2 commits December 7, 2024 07:12
Co-authored-by: Viktor Charypar <[email protected]>
Co-authored-by: Viktor Charypar <[email protected]>
@mhedgpeth
Copy link
Contributor Author

@charypar thanks for the feedback! I accepted your suggestions. I believe that puts my PR in an acceptable state.

@charypar
Copy link
Member

@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.

mhedgpeth and others added 3 commits December 18, 2024 10:38
Co-authored-by: Viktor Charypar <[email protected]>
Co-authored-by: Viktor Charypar <[email protected]>
Co-authored-by: Viktor Charypar <[email protected]>
@mhedgpeth
Copy link
Contributor Author

Fantastic, everything is accepted. Thanks for working with me on this

@charypar charypar merged commit 5e2f894 into redbadger:master Dec 30, 2024
9 checks passed
@charypar
Copy link
Member

Thanks for pushing us to do this @mhedgpeth!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants