Skip to content

Commit 6c5d7a9

Browse files
committed
Improve root README bilingual navigation
1 parent d3b14ac commit 6c5d7a9

1 file changed

Lines changed: 17 additions & 20 deletions

File tree

README.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,31 @@
11
# UMS - Enterprise User Management System
22

3-
UMS is a modular monolith for identity, authorization, configuration, approvals, compliance, IGA, and audit. The repository follows the Evolith baseline and documents UMS-specific evidence, local decisions, and ADR-backed deviations in `docs/`.
3+
> Language: [English](./README.md) | [Español](./docs/README.es.md)
44
5-
## Acceso rápido por idioma
5+
UMS is a modular monolith for identity, authorization, configuration, approvals, compliance, IGA, and audit. It is an applied implementation based on Evolith: reusable enterprise standards live upstream, while UMS documents product-specific evidence, local decisions, and ADR-backed deviations in `docs/`.
66

7-
| Entry | Open this |
7+
## Documentation Entry Points
8+
9+
| Need | Open this |
810
|---|---|
9-
| Read in English | [docs/README.md](./docs/README.md) |
10-
| Leer en Español | [docs/README.es.md](./docs/README.es.md) |
11+
| English documentation portal | [docs/README.md](./docs/README.md) |
12+
| Portal documental en español | [docs/README.es.md](./docs/README.es.md) |
1113
| Master Index | [docs/MASTER_INDEX.md](./docs/MASTER_INDEX.md) |
1214
| Índice Maestro | [docs/MASTER_INDEX.es.md](./docs/MASTER_INDEX.es.md) |
13-
| Documentation Portal | [docs/README.md](./docs/README.md) |
14-
| Portal Documental | [docs/README.es.md](./docs/README.es.md) |
1515
| Standards | [docs/STANDARDS.md](./docs/STANDARDS.md) |
1616
| Estándares | [docs/STANDARDS.es.md](./docs/STANDARDS.es.md) |
1717

1818
## Fast Routes
1919

2020
| Need | Open this |
2121
|---|---|
22-
| Standards | [STANDARDS.md](./docs/STANDARDS.md) / [STANDARDS.es.md](./docs/STANDARDS.es.md) |
23-
| Full English documentation map | [MASTER_INDEX.md](./docs/MASTER_INDEX.md) |
24-
| Full Spanish documentation map | [MASTER_INDEX.es.md](./docs/MASTER_INDEX.es.md) |
2522
| Short navigation by team or goal | [Quick Navigation](./docs/governance/quick-navigation.md) |
2623
| Architecture portal | [Architecture Portal](./docs/architecture/index.md) |
24+
| Portal de Arquitectura | [Portal de Arquitectura](./docs/architecture/index.es.md) |
2725
| Governance portal | [Governance Portal](./docs/governance/index.md) |
26+
| Portal de Gobernanza | [Portal de Gobernanza](./docs/governance/index.es.md) |
27+
| Operations portal | [Operations Portal](./docs/operations/index.md) |
28+
| Portal de Operaciones | [Portal de Operaciones](./docs/operations/index.es.md) |
2829

2930
## At a Glance
3031

@@ -34,7 +35,7 @@ UMS is a modular monolith for identity, authorization, configuration, approvals,
3435
| Frontend | React 18, Vite, TypeScript |
3536
| Monorepo | Nx, npm workspaces |
3637
| Delivery method | BMAD-METHOD, Clean Architecture, DDD |
37-
| Multi-tenancy | Application-layer tenant filtering first, SQL Server RLS as secondary failsafe |
38+
| Multi-tenancy | Application-layer tenant filtering first, SQL Server RLS as a secondary failsafe |
3839

3940
## Local Workflows
4041

@@ -63,16 +64,12 @@ cd src
6364
python ../.bmad-core/scripts/validate_docs_consistency.py README.md docs/
6465
```
6566

66-
## Documentation Map
67+
## What to Expect
6768

68-
| Portal | Purpose |
69-
|---|---|
70-
| [Standards Quick Access](./docs/STANDARDS.md) | UMS applied references and Evolith standards |
71-
| [Master Index](./docs/MASTER_INDEX.md) | English lifecycle map of the documentation tree |
72-
| [Índice Maestro](./docs/MASTER_INDEX.es.md) | Spanish lifecycle map of the documentation tree |
73-
| [Governance Portal](./docs/governance/index.md) | Product direction, requirements, backlog, and construction |
74-
| [Architecture Portal](./docs/architecture/index.md) | Architecture, blueprints, ADRs, and traceability |
75-
| [Operations Portal](./docs/operations/index.md) | Runbooks, metrics, and operational guidance |
69+
- The root README stays short and executive.
70+
- `docs/README.md` and `docs/README.es.md` are the bilingual home pages for documentation.
71+
- `docs/MASTER_INDEX.md` and `docs/MASTER_INDEX.es.md` are the full lifecycle maps.
72+
- UMS-specific evidence belongs in `docs/`, while reusable standards remain in Evolith.
7673

7774
## Governance Notes
7875

0 commit comments

Comments
 (0)