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

PROPOSAL: Extend Unity tutorial with "How do I...?" Code gallery #27

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

bfops
Copy link
Contributor

@bfops bfops commented Jan 22, 2024

This adds a markdown version of a proposal that has been Living in Notion so far.

@@ -0,0 +1,134 @@
# Proposal: Unity tutorial refactor
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bfops bfops marked this pull request as ready for review January 22, 2024 23:49
@bfops bfops requested a review from jdetter January 23, 2024 17:58
@bfops
Copy link
Contributor Author

bfops commented Jan 23, 2024

Adding just @jdetter for initial review, since you're the most functionally familiar with the Unity tutorial.

Comment on lines +121 to +123
- Name for the new docs section?
- “How do I…?”
- “Code Demo Gallery”
Copy link
Contributor

Choose a reason for hiding this comment

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

I would consider the universally-popular "Frequently Asked Questions."

If these will specifically be for features added to the Unity tutorial game, I would consider the more-specific "Add-on Features."

@bfops
Copy link
Contributor Author

bfops commented Jan 30, 2024

Notes from tb with John:

  • zeke's goal (for first pass): Get as many wins as possible without making any real decisions
  • Think about: Where do we want our docs+onboarding to be on MainNet launch?
    • Looking real
    • Functioning tutorial
    • Polished onboarding funnel
    • Clear use cases we meet
    • "Coming soon" / future features, etc.
    • Ways to engage
  • tutorial/docs analytics
    • what's the current state of our GA?
    • can we see users flowing through our current tutorial/docs?
    • where are people falling off?
  • videos are probably more consumable for many users than reading docs
    • as well as specific "finished projects" such as games rather than pieces
    • (the more we can make these out of composable parts in our "code demo" section/videos, the easier to do+maintain those)
  • we should provide github repo, folders, etc. for tutorial parts
    • (maybe fresh start on github repo?)
    • finished download urls
  • we can start now:
    • (tech note: surface subsections in the sidebar)
    • low-hanging stuff (bugs, stale names, upgrading spacetime version)
    • breaking up the tutorial into pieces
    • per-section links into github parts
    • greyboxing the assets, more generic where possible (and fewer assets)
    • start with pt1, pt2+pt3 might be abandoned to the wolves for now

@dylanh724
Copy link
Contributor

dylanh724 commented Feb 26, 2024

Possibly related: Dylan/unity-tutorials-csharp-parity #31

@jdetter jdetter removed their request for review November 8, 2024 18:12
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