Embedded Guides (Usage Guides)

Access Prerequisites

• Permission (module): manageToken — the entire guides group inherits this permission (requiredModules: [manageToken] in the menu).
• License/Feature: None.
• Menu container: GENERAL → group Guides ("book" icon)

What it is / when to use

The Usage Guides (/usage-guides) are static help pages embedded directly in the BackOffice. They do not consume any backend — the content is internationalised text (usageGuides.* keys in the i18n files). They serve as a quick reference inside the tool for operators who handle tokenisation and related flows, complementing (not replacing) this Operator Manual.

The screen has two views:

• Grid (/usage-guides): cards for all available guides.
• Detail (/usage-guides/:id): opens the selected guide in structured sections (Overview, Prerequisites, Steps, Tips, Screen Sections, Buttons/Actions, Fields) and, at the bottom, quick links that navigate directly to the corresponding real screen.

Prerequisites

• Permission: manageToken on the operator's role (dual permission — CPM enum on the backend + dynamic module in the DB). Without it, the Guides group does not appear in the menu.
• License/Feature: None.
• Dependencies on other screens: None — this is static content. The "quick links" at the bottom of each guide, however, lead to screens that have their own permissions/licenses.

Available guides

There are six guides (each one is a route and a submenu item):

Guide	Route	Focus	Full documentation in this manual
Tokenisation	/usage-guides/tokenization	Overview of the tokenisation flow (concepts, prerequisites, steps).	Tokenisation / Token pages
Manage Tokens	/usage-guides/manage-tokens	Create/edit tokens, pricing, swap pairs.	Manage Tokens (Tokenisation group)
NFTs	/usage-guides/nfts	Creation and management of NFTs and collections.	Manage NFTs / Collections
Crowdfunding	/usage-guides/crowdfunding	Creation of crowdfunding offerings and orders.	Crowdfunding
Financial Distributions	/usage-guides/financial-distributions	Distribute tokens/values to holders.	Distribute Tokens / Mass Payment
User Details	/usage-guides/user-details	How to read the user details screen.	User Details

Structure of a guide (detail view)

Each guide is assembled from a list of typed sections in the component. The possible section types are:

Section	Icon	What it provides
overview	flag	Overview / purpose of the feature.
prerequisites	checklist	What must exist beforehand (permissions, data, dependencies).
steps	numbered list	Step-by-step walkthrough of the operation.
tips	tip	Best practices and things to watch out for.
sections	layout	Explanation of the sections/areas of the real screen.
buttons	buttons	What each button/action does.
fields	fields	Meaning of the form fields.

At the bottom of the detail view, the Quick links block (links) renders buttons that navigate to the real screens (e.g. the NFTs guide points to /manage-assets).

Actions and modals

• Open guide (card → "Open"): navigates to /usage-guides/:id and switches to the detail view.
• Back: button in the detail header that returns to the grid (/usage-guides).
• Quick links: shortcuts to the corresponding operational screen. Note: the shortcut does not grant permission — if the operator does not have the module/license for the destination screen, it will not open normally.

Business rules / important notes

Attention

• Static content, no backend. The guides do not reflect the current state of the data and do not validate anything; they are help text. If there is a discrepancy between an embedded guide and the actual behaviour of the screen, the screen and this Operator Manual take precedence.
• Maintenance via i18n. Updating a guide means editing the usageGuides.* keys in pt-br.json, en.json and es.json — every change requires all three languages (project i18n rule).
• Visibility tied to manageToken. Operators without this module do not see the guides, even if they have access to the destination screens through other modules.

Related screens

• Home
• Dashboard