Project 1
Training exercise.
Experience review
This is page to summary our experience during training.
What gaves as a smile?
- Adding custom domain was supper easy to do
- WYSIWYG was really helpful, but not always
- Easy to upload files and work with them
- Link checker
What was confusing for us?
- 🔴 Hard to find something and use documentation
- Example of how to add an API catalog was confusing. Also it will not work correctly if there is some content in sidebars.yaml
- 🔴 Content disappearance:
- One time Arek was not able to add a comment for a PR
- File content disappearance (committed and uncommitted changes)
- 🔴 WYSIWYG sometimes shows content from main branch ignorring your current cahnges
- 🟡 Some times it jumps to another file
- 🟢 After creating an organization you cannot go back
- 🟢 Not informative error when you created already taken project
- 🟡 Cannor rename the project
- 🟢 Redocly bot author for initial commit
- first commit is done by bot instead of the project creator
- we should also consider not push first comment and allow user to operate on empty files with few files added (optional)
- 🟡 It would be good to connect/transfer realm repo to remote, or have a public template and connect it as a GIT source
- 🟡 Menu in Realm sometimes not working (you need to reload the page)
- 🟢 Add indentation to sidebar elements in project in Realm
- 🟢 admonition type="attention" markdoc tag has wrong color
- 🟢 Improve visibility when PR is approuved
- 🟢 Remote content still exists after deleting a branch
- 🟡 Scorecard dosen't show rules with errors, just no data: https://github.com/Redocly/redocly/issues/8230
- 🟢 Issue with ordered list
- 🟢 command + z working bad with colaborative editing
- 🟡 cannor rename file after uploading it (sometimes it freezes)
Legend:
- 🔴 - most confusing
- 🟡 - not critical
- 🟢 - small issue