Skip to content
Last updated
Training exercise.

What made us smile?

  • The CSS editor - the color picker is especially helpful.
  • Ease of configuration - basic knowledge of CSS is enough to customize styling.

What was confusing?

  • The project loads with the last checked-out branch, even if that branch was merged in the previous session.
  • Package update: the update delay is long enough to be confusing.
  • If the user gives a non-existent package version number, there is no error message and the changes can be committed.
  • The + button should create files/folders inside the root directory, not in the focused folder.
  • Screenshot 2024-05-07 at 15.57.54.png this links to CSS variables as building blocks on the Color mode page, not to a CSS variable table, or CSS variables page (which would be expected).
  • Customize styles page does not mention that the user also needs to uncomment imports in redocly.yaml (nor it has a link to this information).
  • The user needs to be informed that they must trigger the build, i.e.:
    • Restart the WYSIWYG, not Reload it or Reload the page, OR:
    • Do these things in strict order:
      1. Add @theme
      2. Create styles.css
      3. Modify redocly.yaml
      4. Refresh page
  • When switching between files, the editor can sometimes jump to the previous file, especially when two users preform actions at the same time.
  • Screenshot 2024-05-07 at 16.24.35.jpg There is no Save button. :)

Nice to have

  • When the user changes the package version, a Change/Update package button, or some sort of immediate notification about what is happening (Downloading package, Switching to version XYZ) would prevent confusion.
  • It would be good to squash branches immediately after commit/push, and to be able to move uncommitted changes between branches.
  • A big, visible tooltip: Hey, you are on a merged branch, do you want to continue? would prevent users from making changes to an already merged branch.