Other Documentation¶
This site is the developer documentation. Three other documentation sets exist, each with its own repository and audience. Look here first when a question is not about the code.
| Set | Audience | Where |
|---|---|---|
| User documentation | People entering data and reading results | epfl-enac.github.io/co2-calculator-user-doc |
| Backoffice guide | Administrators: roles, factors, data contracts | epfl-enac.github.io/co2-calculator-back-office-doc |
| Storybook | Components, design tokens, UI states | co2-calculator-storybook.epfl.ch |
| Developer docs | Architecture, backend, frontend, plans | This site |
Edit them where they live:
- User documentation —
EPFL-ENAC/co2-calculator-user-doc - Backoffice guide —
EPFL-ENAC/co2-calculator-back-office-doc - Storybook stories —
frontend/storybook/stories/andfrontend/src/components/**/*.stories.ts
Frequently wanted pages¶
- CSV column contracts — Data description in the backoffice guide. The backend's emission-type resolution depends on these; see Emission type resolution.
- What a role may do — Roles in the backoffice guide. The enforcement side is Permission System.
- Design tokens — the live token reference renders the real values; Design Tokens explains the architecture behind them.
Do not copy content from those sites into this one. A second copy is how documentation drifts into stating something false.