Skip to main content

IMS documentation

This folder documents how IMS products behave in catalog mode: who can edit which product fields, how the catalog name is generated, how categories are scoped between partner and vendor organizations, and how Row Level Security (RLS) affects queries. It follows the Diátaxis framework, so every page has one job.

Pick the right section​

QuadrantFolderUse it when…
Tutorialstutorials/You are new to catalog mode and want a guided lesson that ends with a working result.
How-to guideshow-to/You already know the system and need to get a specific task done.
Referencereference/You need an exact fact: a permission, a route, a field rule, an error message.
Explanationexplanation/You want to understand why it works this way, which trade-offs were made, and what is still open.

All pages​

Tutorials​

How-to guides​

Reference​

Explanation​

Adding a page​

This folder is updated alongside the code. When behavior changes, update the affected pages in the same pull request.

  1. Choose the quadrant by asking what the reader needs:
    • To learn by doing something end to end: tutorials/.
    • To do one task they already understand: how-to/, with a title that starts with "How to …".
    • To look up a fact: reference/. Describe the system only. Do not give instructions or reasons.
    • To understand a design or a trade-off: explanation/.
  2. Start the page with one or two sentences that say what it gives the reader.
  3. Refer to code with repo-relative paths, for example apps/web/utils/products/product-access.ts.
  4. If a page starts to mix modes, move the extra content to the right quadrant and link to it.
  5. Add the page to the list above.