The documents/ directory is the canonical user-facing documentation baseline for MailStack.
Every maintained feature phase must update its phase record and, when behavior changes, the
relevant user manual, how-to guide, or administrator guide.
python scripts/manage_documents.py new-phase \
--phase-id PHASE-003 \
--title "Feature title" \
--summary "What the phase changes for users"
# Complete the generated phase document and update the affected guides.
python scripts/manage_documents.py sync
python scripts/manage_documents.py check
python scripts/check_documentation_policy.py --base HEAD^ --head HEADsync regenerates this index and DOCUMENTATION_MANIFEST.json. CI fails when generated
content is stale, a phase document remains in draft state, or a feature change lacks the
required documentation update.
| Document | Type | Audience | Status | Version |
|---|---|---|---|---|
| MailStack Administrator Guide | Admin Guide | mailstack-administrators | active | 1.3.0-rc.1 |
| MailStack Baseline | Baseline | maintainers-and-operators | active | 1.3.0-rc.1 |
| MailStack Accessibility Specification | Design Reference | designers-developers-and-maintainers | active | 1.3.0-rc.1 |
| MailStack Future UI Roadmap | Design Reference | designers-developers-and-maintainers | active | 1.3.0-rc.1 |
| MailStack Responsive Specification | Design Reference | designers-developers-and-maintainers | active | 1.3.0-rc.1 |
| MailStack UI Component Matrix | Design Reference | designers-developers-and-maintainers | active | 1.3.0-rc.1 |
| MailStack UI Foundation | Design Reference | designers-developers-and-maintainers | active | 1.3.0-rc.1 |
| MailStack UI Implementation Status | Design Reference | designers-developers-and-maintainers | active | 1.3.0-rc.1 |
| MailStack UI Screen Catalog | Design Reference | designers-developers-and-maintainers | active | 1.3.0-rc.1 |
| Documentation Policy | Documentation Policy | contributors-and-maintainers | active | 1.3.0-rc.1 |
| How to Use MailStack | How To | mailbox-users-and-administrators | active | 1.3.0-rc.1 |
| Documentation and Feature Baseline | Phase | users-operators-and-maintainers | active | 1.3.0-rc.1 |
| Shared UI Foundation and Application Shell | Phase | users-operators-designers-and-maintainers | active | 1.3.0-rc.1 |
| UI Design Intake Baseline | Phase | users-operators-designers-and-maintainers | active | 1.3.0-rc.1 |
| MailStack User Manual | User Manual | mailbox-users | active | 1.3.0-rc.1 |
The files in this directory explain supported product behavior and operator workflows. The
engineering, architecture, security, deployment, and release references remain in ../docs/.
When these sources disagree, the implementation and verified release contracts are authoritative,
and both documentation sets must be corrected in the same change.