Skip to main content

Zontally IRM

Zontally IRM is the Integrated Risk Management application from ZontallyAI Ltd (com.zontally.irm). These pages are the product documentation for that application.

The application definition lives in this repository under artifacts/. Write the guide here, in documentation/docs, as Markdown or MDX.

Write a page​

Add a Markdown file under documentation/docs. The sidebar is generated from that folder. Use sidebar_position to control order:

---
sidebar_position: 2
title: Page title
knowledge_class: Meaning
personas:
  executive: primary
  functional_owner: relevant
---

# Page title

personas records who the page is for. Each of executive, functional_owner, business_user, and administrator is primary or relevant. knowledge_class is one of Meaning, Practice, Judgement, Illustration, or Catalogue. The site shows both at the top of the page. The same frontmatter shape is used on the platform documentation site.

Preview locally​

From documentation/:

npm install
npm start

The site opens at http://localhost:3000. npm run build writes the static site to documentation/build.

Publishing that build to Amazon S3 is described in Publishing.