Platform documentation

Read from the code —the way it is today.

Architecture, identity, writing apps, distribution, operations, runbooks — the repository's own documentation. No sign-in needed.

21documents
1languages
or start from a goal ↓
Every document, one pathpages.mjs · one list
*.md→generate-docs→Next→1 languages
The source is the codewhere they differ, the code is right — fix it by PRbackend/pkg/nexusinternal/workspacefrontend/src/shared/i18n
Where to start

One library — three paths

Pick a goal and read in order. Each path is three documents.

New members, management

Understand the platform

What it is, how it is built, who signs in and how.

3 documents~18 min
  1. 1ТоймWhat it is and who it is for7 min
  2. 2АрхитектурPlanes, core, database5 min
  3. 3Танилт ба эрхeID, sessions, roles6 min
Start →
Developers

Write an app

Write your business logic; take sign-in, permissions, menus, migrations and reports from the platform.

2 documents~19 min
  1. 1Модуль бичихRegister through pkg/nexus4 min
  2. 2Bridge гэрээTalk to the native shells15 min
Start →
All documents

21 documents — 6 groups

Every document says which part of the code it was read from.

Updates

When the code changes — so do the docs

Latest changes

All changes →

    How they are updated

    Docs are changed in the same PR as the code. Merged into main, they are published on their own — nothing by hand.

    1. ReviewCode and docs in one PR
    2. Buildgenerate-docs → Next
    3. DeployPublished in 1 languages
    Last published: 21 documents
      DEV · Хөгжүүлэлтийн орчин