Skip to content

Commit 0338b77

Browse files
docs: improve standards quick access
Improve standards quick access navigation.
1 parent 2a4b032 commit 0338b77

4 files changed

Lines changed: 100 additions & 16 deletions

File tree

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# UMS — Enterprise User Management System
22

3-
> **[ 📚 OPEN MASTER INDEX ](./docs/MASTER_INDEX.md)[ 🇪🇸 LEER EN ESPAÑOL ](./docs/README.es.md)[ ⚙️ ARCHITECTURE PORTAL ](./docs/architecture/index.md)**
3+
> **[OPEN STANDARDS](./docs/STANDARDS.md)[OPEN MASTER INDEX](./docs/MASTER_INDEX.md)[LEER EN ESPAÑOL](./docs/README.es.md)[ARCHITECTURE PORTAL](./docs/architecture/index.md)**
44
> *Note: GitHub displays source files first. To skip the code and read the documentation, click the links above.*
55
66
---
@@ -11,22 +11,36 @@
1111
1212
---
1313

14+
## Standards Quick Access
15+
16+
| Need | Direct path |
17+
| :--- | :--- |
18+
| UMS applied React Web reference | [UMS React Web Applied Reference](./docs/architecture/web-frontend/ums-react-applied-reference.md) |
19+
| UMS applied .NET API reference | [UMS API .NET Applied Reference](./docs/architecture/api-dotnet/ums-api-dotnet-applied-reference.md) |
20+
| Upstream Evolith React standard | [Evolith React Web Frontend Standard](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/react-web-frontend-standard.md) |
21+
| Upstream Evolith .NET API standard | [Evolith .NET API Standard](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/api-dotnet/api-dotnet-standard.md) |
22+
| All standards in one page | [Standards Quick Access](./docs/STANDARDS.md) |
23+
24+
---
25+
1426
## Master Navigation Index
1527
Start here if you are new to UMS. This index gives each reader a fast route into the repository without needing to know the folder structure.
1628

1729
### Quick Route by Persona
1830

1931
| I am a… | Start here | Then read |
2032
| :--- | :--- | :--- |
21-
| **Backend Engineer** | [Construction Portal](./docs/governance/construction/index.md) · [Domain Aggregate Index](./docs/domain/index.md) | [DDD Design Portal](./docs/governance/construction/ddd-design/index.md)[Bounded Context Map](./docs/governance/construction/ddd-design/01-bounded-context-map.md) |
22-
| **Architect** | [Architecture Portal](./docs/architecture/index.md) · [ADR Registry](./docs/architecture/adrs/index.md) | [Bounded Context Map](./docs/governance/construction/ddd-design/01-bounded-context-map.md)[Traceability Matrix](./docs/architecture/traceability-matrix.md) |
33+
| **Backend Engineer** | [Standards Quick Access](./docs/STANDARDS.md) · [Construction Portal](./docs/governance/construction/index.md) · [Domain Aggregate Index](./docs/domain/index.md) | [UMS API .NET Applied Reference](./docs/architecture/api-dotnet/ums-api-dotnet-applied-reference.md)[DDD Design Portal](./docs/governance/construction/ddd-design/index.md) |
34+
| **Frontend Engineer** | [Standards Quick Access](./docs/STANDARDS.md) · [UMS React Web Applied Reference](./docs/architecture/web-frontend/ums-react-applied-reference.md) | [Evolith React Web Frontend Standard](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/react-web-frontend-standard.md) |
35+
| **Architect** | [Architecture Portal](./docs/architecture/index.md) · [ADR Registry](./docs/architecture/adrs/index.md) | [Standards Quick Access](./docs/STANDARDS.md)[Traceability Matrix](./docs/architecture/traceability-matrix.md) |
2336
| **Product Owner / QA** | [Master Index](./docs/MASTER_INDEX.md) · [Functional Stories](./docs/governance/requirements/functional-stories/index.md) | [MVP Backlog](./docs/governance/project/mvp-product-backlog.md)[Glossary](./docs/governance/requirements/glossary.md) |
2437
| **DevOps / Ops** | [Operations Portal](./docs/operations/index.md) · [Runbooks](./docs/operations/runbooks/) | [ADR-0053 OpenTelemetry](./docs/architecture/adrs/0053-opentelemetry-observability.md)[ADR-0054 Shell Library Isolation](./docs/architecture/adrs/0054-shell-library-isolation.md) |
2538

2639
### I want to…
2740

2841
| Goal | Start Here | Then Read |
2942
| :--- | :--- | :--- |
43+
| Find standards for React, Web, C# or .NET | [Standards Quick Access](./docs/STANDARDS.md) | [Architecture Portal](./docs/architecture/index.md) |
3044
| Understand the product | [Product Vision](./docs/governance/product/product-vision.md) | [Business Context](./docs/governance/product/business-context.md)[Scope](./docs/governance/product/scope.md) |
3145
| See Epics & Priorities | [MVP Product Backlog](./docs/governance/project/mvp-product-backlog.md) | [Requirements Index](./docs/governance/requirements/index.md)[Functional Stories](./docs/governance/requirements/functional-stories/index.md) |
3246
| Review functional requirements | [Requirements Index](./docs/governance/requirements/index.md) | [Functional Stories](./docs/governance/requirements/functional-stories/index.md)[Glossary](./docs/governance/requirements/glossary.md) |
@@ -41,9 +55,9 @@ Start here if you are new to UMS. This index gives each reader a fast route into
4155
### Technology Stack
4256
| Layer | Technology |
4357
| :--- | :--- |
44-
| **Backend** | .NET 8 LTS, HotChocolate (GraphQL), Minimal APIs (REST) |
58+
| **Backend** | .NET 10, HotChocolate (GraphQL), Minimal APIs (REST) |
4559
| **Frontend** | React 18, Vite 5, TypeScript, TailwindCSS, Zustand, TanStack Query |
46-
| **Database** | SQL Server 2022, Entity Framework Core 8 |
60+
| **Database** | SQL Server 2022, Entity Framework Core |
4761
| **Monorepo** | Nx, npm Workspaces |
4862
| **Methodology** | BMAD-METHOD, Clean Architecture (Hexagonal), DDD |
4963

@@ -78,7 +92,7 @@ src/
7892

7993
### Prerequisites
8094
- Node.js 20+
81-
- .NET 8 SDK
95+
- .NET 10 SDK
8296
- SQL Server 2022 (or Docker: `docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=YourPassword123!" -p 1433:1433 mcr.microsoft.com/mssql/server:2022-latest`)
8397

8498
### Frontend
@@ -124,6 +138,7 @@ cd src/apps/ums.web-app && npm run dev
124138
## Knowledge Hub
125139
| Domain | Portal Index | Contents |
126140
| :--- | :--- | :--- |
141+
| **Standards** | [Standards Quick Access](./docs/STANDARDS.md) | Direct links to Evolith standards and UMS applied references for React Web and .NET API. |
127142
| **Governance** | [Governance Portal](./docs/governance/index.md) | Product direction, business scope, and functional requirements. |
128143
| **Project Delivery** | [Project Backlog](./docs/governance/project/index.md) | MVP epics, user stories, and functional design of core modules. |
129144
| **Requirements** | [Requirements Index](./docs/governance/requirements/index.md) | Functional stories, business glossary, and conceptual data model. |
@@ -139,11 +154,3 @@ cd src/apps/ums.web-app && npm run dev
139154
- **CSRF Protection**: Double-submit cookie pattern with token refresh.
140155
- **Security Headers**: HSTS, X-Frame-Options, X-Content-Type-Options, Referrer-Policy via Nginx.
141156
- **Input Validation**: Zod schemas as single source of truth for runtime validation.
142-
143-
---
144-
145-
## Contribution & Governance
146-
- **Workflow**: This repo uses [BMAD-METHOD](./AGENTS.md) for spec-driven documentation.
147-
- **Navigation**: Visit the [**Master Index**](./docs/MASTER_INDEX.md) for the full document tree.
148-
- **Code Standards**: ESLint + TypeScript strict mode. Zero errors required before commit.
149-
- **Testing**: Vitest with React Testing Library. Coverage thresholds: 60% lines/statements.

docs/README.es.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# UMS — Sistema de Gestión de Usuarios Empresarial
22

3-
> **[ABRIR ÍNDICE MAESTRO](./MASTER_INDEX.es.md)[READ IN ENGLISH](../README.md)[PORTAL DE ARQUITECTURA](./architecture/index.es.md)**
3+
> **[ABRIR ESTÁNDARES](./STANDARDS.es.md)[ABRIR ÍNDICE MAESTRO](./MASTER_INDEX.es.md)[READ IN ENGLISH](../README.md)[PORTAL DE ARQUITECTURA](./architecture/index.es.md)**
44
> *Nota: GitHub muestra los archivos de código primero. Para saltar el código y leer la documentación, haz clic en los enlaces de arriba.*
55
66
---
@@ -11,12 +11,25 @@
1111
1212
---
1313

14+
## Acceso rápido a estándares
15+
16+
| Necesidad | Ruta directa |
17+
| :--- | :--- |
18+
| Referencia aplicada React Web UMS | [Referencia Aplicada React Web UMS](./architecture/web-frontend/ums-react-applied-reference.es.md) |
19+
| Referencia aplicada API .NET UMS | [Referencia Aplicada API .NET UMS](./architecture/api-dotnet/ums-api-dotnet-applied-reference.es.md) |
20+
| Estándar React upstream Evolith | [Estandar Web Frontend React Evolith](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/react-web-frontend-standard.es.md) |
21+
| Estándar API .NET upstream Evolith | [Estandar API .NET Evolith](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/api-dotnet/api-dotnet-standard.es.md) |
22+
| Todos los estándares en una página | [Acceso Rápido a Estándares](./STANDARDS.es.md) |
23+
24+
---
25+
1426
## Índice maestro de navegación
1527

1628
Comience aquí si es nuevo en UMS. Este índice ofrece a cada lector una ruta rápida al repositorio sin necesidad de conocer la estructura de carpetas.
1729

1830
| Quiero... | Empezar aquí | Luego leer |
1931
| :--- | :--- | :--- |
32+
| Encontrar estándares React, Web, C# o .NET | [Acceso Rápido a Estándares](./STANDARDS.es.md) | [Portal de Arquitectura](./architecture/index.es.md) |
2033
| Entender el producto | [Visión del Producto](./governance/product-es/product-vision.md) | [Contexto de Negocio](./governance/product-es/business-context.md)[Alcance](./governance/product-es/scope.md) |
2134
| Ver épicas y prioridades | [MVP Product Backlog](./governance/project-es/mvp-product-backlog.md) | [Índice de Requerimientos](./governance/requirements-es/index.md)[Historias Funcionales](./governance/requirements-es/functional-stories/index.md) |
2235
| Revisar requerimientos funcionales | [Índice de Requerimientos](./governance/requirements-es/index.md) | [Historias Funcionales](./governance/requirements-es/functional-stories/index.md)[Glosario](./governance/requirements-es/glossary.md) |
@@ -126,10 +139,11 @@ cd src/apps/ums.web-app && npm install && npm run dev
126139

127140
| Dominio | Índice del portal | Contenido |
128141
| :--- | :--- | :--- |
142+
| **Estándares** | [Acceso Rápido a Estándares](./STANDARDS.es.md) | Enlaces directos a estándares Evolith y referencias aplicadas UMS para React Web y API .NET. |
129143
| **Gobernanza** | [Portal de Gobernanza](./governance/index.es.md) | Dirección del producto, alcance de negocio y requerimientos funcionales. |
130144
| **Entrega del proyecto** | [Backlog del Proyecto](./governance/project-es/index.md) | Épicas MVP, historias de usuario y diseño funcional de módulos core. |
131145
| **Requerimientos** | [Índice de Requerimientos](./governance/requirements-es/index.md) | Historias funcionales, glosario de negocio y modelo de datos conceptual. |
132-
| **Arquitectura** | [Portal de Arquitectura](./architecture/index.es.md) | Diseño ER de base de datos, mapas de entidades y visores interactivos. |
146+
| **Arquitectura** | [Portal de Arquitectura](./architecture/index.es.md) | Diseño ER de base de datos, entity maps y visores interactivos. |
133147
| **Construcción** | [Portal de Construcción](./governance/construction/index.es.md) | Diseño DDD de la capa de dominio: bounded contexts, agregados, eventos y comandos. |
134148

135149
---
@@ -147,5 +161,6 @@ cd src/apps/ums.web-app && npm install && npm run dev
147161

148162
- **Flujo de trabajo**: Este repositorio utiliza [BMAD-METHOD](../AGENTS.md) para documentación orientada a especificaciones.
149163
- **Navegación**: Visite el [Índice Maestro](./MASTER_INDEX.es.md) para el árbol completo de documentos.
164+
- **Estándares aplicados**: Visite [Acceso Rápido a Estándares](./STANDARDS.es.md) para React Web, API .NET y referencias Evolith.
150165
- **Estándares de código**: ESLint + TypeScript strict mode. Cero errores requeridos antes de commit.
151166
- **Testing**: Vitest con React Testing Library. Umbrales de cobertura: 60% líneas/sentencias.

docs/STANDARDS.es.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Acceso Rapido a Estandares
2+
3+
Usa esta pagina cuando necesites llegar rapido a las referencias aplicadas de UMS y a los estandares upstream de Evolith.
4+
5+
## Referencias aplicadas UMS
6+
7+
| Area | Referencia aplicada UMS | Estandar upstream Evolith |
8+
|---|---|---|
9+
| Frontend React Web | [Referencia Aplicada React Web UMS](./architecture/web-frontend/ums-react-applied-reference.es.md) | [Estandar Web Frontend React Evolith](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/react-web-frontend-standard.es.md) |
10+
| Backend API .NET | [Referencia Aplicada API .NET UMS](./architecture/api-dotnet/ums-api-dotnet-applied-reference.es.md) | [Estandar API .NET Evolith](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/api-dotnet/api-dotnet-standard.es.md) |
11+
12+
## Accesos Evolith
13+
14+
| Necesidad | Enlace |
15+
|---|---|
16+
| Todos los estandares por stack | [Evolith Quick Access by Stack](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/quick-access/README.es.md) |
17+
| Portal estandar React | [Portal Web Frontend React](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/README.es.md) |
18+
| Portal estandar API .NET | [Portal API .NET](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/api-dotnet/README.es.md) |
19+
20+
## Regla de autoridad
21+
22+
| Tipo | Fuente de verdad |
23+
|---|---|
24+
| Estandar empresarial reutilizable | Evolith |
25+
| Evidencia de implementacion especifica de producto | UMS |
26+
| Ruta, modulo, header, schema, seed o valor runtime local | UMS |
27+
| Practica destinada a todos los productos | Promover a Evolith mediante ADR, estandar o patron canonico |
28+
29+
---
30+
31+
[Volver al README UMS](./README.es.md)

docs/STANDARDS.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Standards Quick Access
2+
3+
Use this page when you need the shortest route to the UMS applied references and the upstream Evolith standards.
4+
5+
## UMS applied references
6+
7+
| Area | UMS applied reference | Upstream Evolith standard |
8+
|---|---|---|
9+
| React Web frontend | [UMS React Web Applied Reference](./architecture/web-frontend/ums-react-applied-reference.md) | [Evolith React Web Frontend Standard](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/react-web-frontend-standard.md) |
10+
| .NET API backend | [UMS API .NET Applied Reference](./architecture/api-dotnet/ums-api-dotnet-applied-reference.md) | [Evolith .NET API Standard](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/api-dotnet/api-dotnet-standard.md) |
11+
12+
## Evolith shortcuts
13+
14+
| Need | Link |
15+
|---|---|
16+
| All standards by stack | [Evolith Quick Access by Stack](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/quick-access/README.md) |
17+
| React standard portal | [React Web Frontend Standard Portal](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/README.md) |
18+
| .NET API standard portal | [.NET API Standard Portal](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/api-dotnet/README.md) |
19+
20+
## Authority rule
21+
22+
| Type | Source of truth |
23+
|---|---|
24+
| Reusable enterprise standard | Evolith |
25+
| Product-specific implementation evidence | UMS |
26+
| Local route, module, header, schema, seed or runtime value | UMS |
27+
| Practice intended for all products | Promote to Evolith through ADR, standard or canonical pattern |
28+
29+
---
30+
31+
[Back to UMS README](../README.md)

0 commit comments

Comments
 (0)