Project 1 Summary

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

What gave you a smile?

1. Overall editor experience was nice and smooth. There are some smaller items that need to be addressed.
2. With relatively small amount of code, we were able to produce rich API documentation
3. Connecting custom domain went smoothly
4. Creating organization, invite was working correctly (we didn't face issue with logged in user not able to accept invite, because I was logged out when accepting invite)
5. Link checker functionality is very useful

What was most confusing?

1. File upload - there is no indicator while uploading a file, it looks like it not working, but finally files are in place. Missing paste images directly to text editor.
2. Both of us saw different things on specific Pull Request page, there is sync between ui<>server because we both see that everything is "green", but other person doesn't have full list of comments (eg. XXX approved your PR), which is easy to fix.
3. Documentation is not great, there is no straightforward step by step configuration.
   1. Search in documentation not working correctly - higlight not important pages (like CSS configuration instead of feature configuration)
   2. We should update some titles for search engine, like "RULES" > "LINT RULES", because when we looking for "LINT" there is no search results.
4. We have a lot of issues to configure redocly.yaml to achive eg. changelog, we added changelog, then Catalog stop working, scorecards are missing... etc.
   1. We should add some Cookbook with "How to add custom page to API", "How to configure catalog"
5. We should consider to implement some graphic conflicts resolver, because "Sync" button override all changes without any confirmation
6. Wysiwig synchronization with editor tabs is confusing when navigating to pages not directly related to specific files. Sometimes it resulted in us being redirected to already opened file.
7. It would be great to have better autocomplete in editor, to avoid searching documentation, but to have context-specific redocly.yaml configuration options presented inline. Check https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml for example on how we can hover on yaml elements to see documentation (in this case Kubernetes syntax support).
8. I was missing option to share link to specific line with my team mate to show him where is an issue.
9. Check more on issues list