Skip to content
Last updated
Danger

Training exercise.

Getting started with Reunite notes

  • When user wants to have getting started side-by-side with Reunite editor, it's hard to notice WYSIWYG: side-by-side-getting-started.png
  • Notification about pull request being updated (after commit) overlap the content (View project button for instance). It would be great to have close button on notification if user wants to click on the overlapped content. Eventually maybe we should show notifications in some fixed place? At the bottom of editor?
  • It would be nice to have keyboard shortcuts for creating new file
  • It wasn't noticed that about.md file was created inside .github folder
  • It was noted that redocly.yaml file is empty now (no commented-out code). This may make user a bit lost. Maybe we should at least include comment with link to the getting started guide at the top of the redocly.yaml file?
  • After changing styles in styles.css file, WYSIWYG didn't show it.
  • Getting started guide seems to contain a lot of text, which we didn't read entirely. Maybe we can think about squeezing it?

Getting started locally notes

  • Before a user starts setting up a project, it's also helpful to have a list of commands they can use to do so.

  • During the initial steps of the setup, it indicates that a Git repository needs to be created. However, this requirement is not mentioned at the beginning of the guide, only at the end. git_noteguide.png

  • Show incorrect local link (windows machine and WSL) - CLI was showing http://127.0.0.1:4000, but this url is not working under WSL and user had to go to http://localhost:4000 to see the page. screenshot1-1.png screenshot1-2.png

  • It was also noticed that our logo in the guide has a long name with different symbols and the user has to rename it, it would be better to have the name shown in the code example.

  • Get started guide has screenshots with old designs;

  • Get started guide has a mistake: mentions styles.css and style.css styles-s.png

  • It was noticed that in the example @theme/styles.css for navbar bg and footer bg incorrect variable names are used - we tried to change the name -background- to -bg-, and after that everything worked. styles-cases1.png styles-cases1 copy.png

  • It was noted that this step Log in to Reunite and create a new project; connect to your Git remote repository. need some addional links to tutorials/documentation.

Interview with Andrew observations

  • Initial navigation to editor, creating branch was clean it seems our UI/UX is very good for 'getting started'
  • Changes view on index.md took a long time to load
  • Some confusion whether to merge PR or not maybe we should improve documenation here and be explicit if user has to merge or not
  • Andrew made the same mistake as we did (see Getting started with Reunite notes above) - he put about.md in .github folder. Maybe we can consider removing .github folder from initial template? Or think about making more visible to the user where he uploads the file.
  • WYSIWYG properly reflected changes in @theme folder (but we did our training after video and we've had an issue with WYSIWYG loading style changes, but maybe we didn't wait long enough)
  • User asked about staging files in GIT (it's not possible currently and no plans to do it)
  • Revert button - hover tooltips would be nice to have for all single icon buttons (at least)
  • Side-by-side comparison was confusing (left side shows error when page doesn't exist, maybe we should have some more meaningful message like This page doesn't exist in this version or something)
  • Pricing - not identified Realm as selector in heading (this is already addressed in latest pricing page design)
  • Link to calculator is hidden (it's on purpose so maybe after more interviews we should rethink it if users will be confused)
  • Extras block on pricing calculator - it's not clear for the user what is included in basic price and for what he has to pay extra
  • User asked about changelog feature - we've presented him tool that we are using (changesets). Maybe we can consider adding changelog functionality to Reunite so users don't have to use some external tools.

Experience review

What made you smile?

  • We've added changes to some of the feedback points noted here so they are already addressed (or close to be addressed) like pricing page.
  • WYSIWYG seems to work properly as of now (refreshing styles etc.)

What did you find confusing?

  • Editor is still slow when I navigate across code (for instance keep pressing arrow/backspace buttons)
  • WYSIWYG didn't reload for us after style changes (even though we did training after Andrew's interview where it was working fine)
  • When uploaded files with non latin characters, editor renamed it to something strange like Знімок екрана 2024-07-23 о 11.59.52.png