Skip to content

Conversation

@RikuTheFuffs
Copy link
Contributor

@RikuTheFuffs RikuTheFuffs commented Oct 7, 2024

Description

  • Added a welcome dialog to guide users on their first time experience
  • Added a Table of Contents with helpful resources, that can be accessed from the Tutorials > Show Tutorials menu

image

image

Issue Number(s)

How to test/validate

  1. Clone this branch
  2. Open it with Unity
  3. The welcome dialog will show up
  4. Go to Tutorials > Show Tutorials to open the Table of Contents
  5. Click all the links to ensure they work

Contribution checklist

  • Release notes have been added to the project changelog file and/or package changelog file
  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • JIRA ticket ID is in the PR title or at least one commit message
  • Include the ticket ID number within the body message of the PR to create a hyperlink

@RikuTheFuffs RikuTheFuffs requested a review from a team as a code owner October 7, 2024 12:03
@unity-cla-assistant
Copy link

unity-cla-assistant commented Oct 7, 2024

CLA assistant check
All committers have signed the CLA.

@RikuTheFuffs RikuTheFuffs changed the title In editor tutorials [MTT-8698], [MTT-8694] In editor tutorials: Welcome dialog and table of contents [MTT-8698], [MTT-8694] Oct 7, 2024
@RikuTheFuffs RikuTheFuffs changed the base branch from main to develop October 7, 2024 12:05
@RikuTheFuffs RikuTheFuffs requested review from a team October 7, 2024 14:57
@gopher-atz
Copy link

small FTUE feedback:

  • i would make the the welcome dialog just 2 lines bigger in y, so you can get rid of the scrollbar completely
  • the tutorial window is (in my case) docked at the very right side of the editor and squashed
    TutorialScreenshot, i would consider to have it floating as well initially (people can still doch later)

@gopher-atz
Copy link

when the tutorial window gets smaller in y, there's some layout issues with the menu bar on top.
it gets overlayed by the content section and you cannot click the buttons in tghe overlap zone.
TutorialScreenshot2

@gopher-atz gopher-atz self-requested a review October 8, 2024 08:15
@RikuTheFuffs
Copy link
Contributor Author

RikuTheFuffs commented Oct 8, 2024

  1. i would make the the welcome dialog just 2 lines bigger in y, so you can get rid of the scrollbar completely
  2. the tutorial window is (in my case) docked at the very right side of the editor and squashed
  3. when the tutorial window gets smaller in y, there's some layout issues with the menu bar on top.

@gopher-atz I agree with you but we do not control the size or position of those elements. They're managed by the tutorial framework and tutorial authoring tools packages, internally.

On 1: What we can do is removing 2 lines from the welcome dialog. Here's the updated copy.

image

On 2: the docking to the right of the inspector is the default In-Editor Tutorials behaviour. To solve the squashing I can try setting a project layout that is loaded automatically at startup, and give more space to the tutorial window there.

This is how it should show up now, can you have another look? (Tutorials > Authoring > Debug > Run startup code)

image

On 3: it's an IET bug that should be addressed cc @guillaumed-unity

gopher-atz
gopher-atz previously approved these changes Oct 8, 2024
@RikuTheFuffs RikuTheFuffs enabled auto-merge October 8, 2024 10:05
@RikuTheFuffs
Copy link
Contributor Author

The failing tests were already failing on develop, they won't be fixed in this PR. (see #889 )

image

@RikuTheFuffs RikuTheFuffs disabled auto-merge October 8, 2024 13:04
@RikuTheFuffs RikuTheFuffs enabled auto-merge (squash) October 8, 2024 13:04
@RikuTheFuffs RikuTheFuffs disabled auto-merge October 8, 2024 13:04
@RikuTheFuffs RikuTheFuffs enabled auto-merge (squash) October 8, 2024 17:31
@RikuTheFuffs RikuTheFuffs merged commit 59d1080 into develop Oct 8, 2024
13 checks passed
@RikuTheFuffs RikuTheFuffs deleted the feat/in-editor-tutorials branch October 8, 2024 19:36
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