Skip to content
Last updated

Debrief project 14

Training exercise

What made you smile?

  • Create products from existing APIs was pretty fast process! Docs are clear and has enought information about how to do it.

What was confusing?

  • We tried to setup catalog for the 'API HUB' product. We crated the next catalog config in redocly.yaml file:
    catalog:
      api-hub-catalog:
        title: Api Hub Catalog
        description: 'API Catalog'
        slug: /products/api-hub/
        items:
          - directory: ./products/api-hub
    The problems we faced:
    • The catalog slug /products/api-hub/ is the same as a product slug, however the product picker redirects us to the first api from the products folder
    • We commented the catalog config, and added index.md into api-hub folder. We was expecting that the product picker redirects us to that index.md, but we see the first api from the products folder. This fisrt api has its own sidebars.yanl file. Deletion of that file allows the product picker to link us to the index.md, which is expected.

  • srcSet doesn't work in products(nested) redocly.yaml files.

  • Page selector on review has no max height, so scroll breaks layout.

Screenshot 2024-07-31 at 17.47.28.png