Project 27

Our walkthrough guide

Preparation

🗣️ Identify target persona

We created this guide for Monobank 🐈‍⬛ .

🏗️ Decide what to build

Our redocly.yaml highlights the following features:

• Public API documentation for marketplace payment integration
• Integration with restaurants (online menus, electronic invoices)
• Split payment integration

What combination of Redocly products are they using?

• Redoc + Revel

Which features do you think are most valuable to this customer?

• openapi
• sidebar
• codeSnippet
• logo
• products
• versionPicker
• rbac
• analytics
• feedback

What made you smile?

• Code highlighting on selection
• Ability to download example files

What did you find confusing?

• Configuration

  • In general, we do not understand why both languages and groups are needed, along with many required properties. It feels over complicated.
  • Why do we need a default property for groups? Why not just use the first element in the array?
  • Why is the step title required?

• Documentation

  • We didn't see any examples with screenshots how this componets looks.
  • Order of guides is confusing. It wopuld be better to start from Create code walkthrough
  • For Create code walkthrough it would be good to use walkthrough component with ability to download example files
  • Add explanation why groups is needed
  • We need to proofread docs, there's a lot of grammar mistakes.
  • Conditional chunks - missing examples

• Bugs Reunite

  • When we created a file we didn't see it from the commit tab (reproduced only once)
  • syncer pending status in db after page refresh

• Bugs code-walkthrough tag:

  • Download pulls all files to the same folder, overriding files with the same name (should preserve folder structure)
  • Warning with path for downloadOnlyFiles (it disapears after a few minutes)
  • When you switch between two walkthrough examples the code content disapears (reload is needed)

• Bugs Realm

  • copy button in realm code samples doesn't always work