Safenai Documentation

Golden rule

Anything written in this repository can be challenged and discussed. Yet no implementation shall be in contradiction of these elements without a specific decision.

Purpose of this documentation

The aim of this documentation it to contain all relevant information associated to the products developed by Safenai.

• First the specification as requirements for the development team.
• Then the documentation and manual for the different users.

As of January 2026 the documentation is not up to date and is in lack of consistency.

You will find the following structure of documentation :

• Introduction and overview of klarity : this page
• A getting started : part to allow you to deploy and test on a basic project example
• Klarity documentation : documentation of each application in klarity
• Concept : an overview of concept behind klarity
• Architecture and roadmap : our architecture choice and roadmap

The content of this repository is to be shared between development team and management team.

Usage process

If you want to :

1. propose an alternative to some design content,

2. detail a specific part or element,

3. add new section,

4. update this readme

   You'll have to create a dedicated branch containing your proposal (starting with a draft of the upcoming content might be a good idea if you fear writting thousands of pages that might end up being rejected in fine) and then to open a merge request of this branch over the dev branch : the discussion will be held in the merge request.

5. precision on a specific item or subject of the main branch.

   You can open an issue in the repository, with the label "discussion". Don't forget to provide to provide link to the different section of the design repo you need information about.

6. correct typos, and add link between differents elements.

   Do it directly in the main branch.

7. declare activities regarding the specification, development or anything pratical to generate content or develop app

   Please do it in the team activities board directly.

8. add need content

   What kind of content might be added Please do it in the team activities board directly.

   • Architecture choice
   • User journey
   • Sample of data that might be manage ... every thing that can help developper to perform their task or a newcomer to understand Klarity.

Table of acronyms

Acronym	Signification	Definition
AI	Artificial Intelligence	I really hope you didn't need this one...
KD	Klarity Dashboard
KC	Klarity Craft
MLOps	Machine Learning Operations	set of practices that automate and simplify machine learning (ML) workflows and deployments.
MVP	Minimum Viable Product	Version usable by first client on a reduced scope
PCI	Product Configuration Item	The PCI is the key object managed by KD as any decision is taken for a specific Project Configuration Item version
PCIV	Product Configuration Item Version	An instance of a project configuration item
POC	Proof of Concept	Version used for demonstration
REQ	Requirement
RBAC	Role-based access control	Designate the rules that specifies who can access what depending on their role
VO	Version 0	Designate the Product Version 0, which is the product version that follows the MVP