Dylan/onboarding-upgrades

dylanh724 commented 5 months ago

Problem

Onboarding towards the path of C# and Unity experiences a minor block, alongside minor inconsistencies, bloat and room for UX improvements.

Solution

Fixed a blocking syntax error with the "Hello World" CLI example.
Fixed broken .unitypackage URL in C# ref.
Polished with minor typo fixes, code consistency (basing on other examples), more internal reference links.
Additional warning regarding C# speed vs Rust.
In the Unity tutorial, we go the path of Rust for the module: Unity devs are more-likely wanting C# for a quickstart (since we 100% know they know C#, but unsure regarding Rust):
- Linked to C# Module tutorial before we jump to Rust, as a placeholder.
- For pt2 (a future PR), I'll work with @jdetter to parity the Rust code in C# to diverge tutorial a bit (or perhaps have code tabs, as John suggested).
Renamed Unity3d refs to the modern-named Unity and added "or Rider" appended to Visual Studio mentions.
Added OneTimeQuery C# api ref.
Related, I opened another PR on spacetime-web that fixes all external links that are currently showing as unstyled.
Verbose Details with Screenshots (Google Doc - Clockwork Only)

Testing

There was a README note instructing how to test below, but there seemed to be no instructions below (I also removed this note). However, I was able to use the preview pane in Rider to ensure expected visuals.

(Edit: Squashed for clarity)

dylanh724 commented 5 months ago

✅ Went through all the raised issues

dylanh724 commented 5 months ago

New commit: Filter and Find being shown interchangeably in C# tutorial. Normalized to Find instead of Filter, since discussing just looking if 1 user exists.

dylanh724 commented 5 months ago

Edited in the Google Doc draft with screenshots and verbose details (only Clockwork can view+comment for now):

dylanh724 commented 5 months ago

Additionally pushed copy+paste redundant comments in Unity pt1:

(💡 I'm only pushing very minor changes from here, while this is still pending; let me know if you prefer I stop completely. Anything new is unsquashed.)

dylanh724 commented 5 months ago

New minor commit: Removed a Unity-pt1 using directive, and merged some info with another using statement that seems to now include the one removed:

dylanh724 commented 5 months ago

New minor commit: Better code spacing for a crunched block

dylanh724 commented 5 months ago

New minor commit: Add a memo that standalone mode will run in the foreground, which may throw some off when you need to publish (and keep this open). Thanks for the idea, @PuruVJ (I experienced the same friction, myself)

(Final addendum for this shift, and perhaps for this entire PR minus other suggestions)

dylanh724 commented 5 months ago

New minor commit: Removed speed mention, added foreground memo for standalone mode in Unity pt1 (since we're going to issue 2 commands one-after-another).

dylanh724 commented 5 months ago

There's another fix I want to add, but didn't yet since it's a bit more complex:

Swapping PlayerComponent to nullable with FindBy instead of FilterBy will fix a syntax err. This part is straight-forward.
Then, we probably want to check if is not null, but this suddenly makes me realize: What if it is null?
- In the tutorial, we never actually used the CreatePlayer Reducer, although we did create it. Is this the place to use if the PlayerComp is null? CC @bfops