Skip to content

Commit a4b5f40

Browse files
committed
feat(design): establish MailStack UI design intake baseline
1 parent 0680970 commit a4b5f40

61 files changed

Lines changed: 2042 additions & 93 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/pull_request_template.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,15 @@ Describe the change and the operational problem it solves.
1010

1111
## Documentation baseline
1212

13+
- [ ] UI/design changes preserve original references and pass the design manifest and contract tests
14+
- [ ] Planned or future-review controls remain inactive unless this PR contains the approved feature architecture
1315
- [ ] A `documents/phases/PHASE-NNN-*.md` record was added or updated
1416
- [ ] User-facing changes update `USER_MANUAL.md`, `HOW_TO_USE.md`, or `ADMIN_GUIDE.md`
1517
- [ ] `CHANGELOG.md` was updated
1618
- [ ] `python scripts/manage_documents.py check`
1719
- [ ] `python scripts/test_documents.py`
20+
- [ ] `python scripts/manage_designs.py --root . check`
21+
- [ ] `python scripts/test_designs.py`
1822
- [ ] `python scripts/check_documentation_policy.py --base HEAD^ --head HEAD`
1923

2024
## Verification

.github/workflows/ci.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,12 @@ jobs:
5353
- name: Documentation system tests
5454
run: python scripts/test_documents.py
5555

56+
- name: UI design intake integrity
57+
run: python scripts/manage_designs.py --root . check
58+
59+
- name: UI design system tests
60+
run: python scripts/test_designs.py
61+
5662
- name: Feature documentation policy
5763
env:
5864
DOCUMENTATION_BASE_SHA: ${{ github.event_name == 'pull_request' && github.event.pull_request.base.sha || github.event.before }}

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ All notable repository-level changes are recorded here. Application history befo
66

77
### Changed
88

9+
- Imported and verified the complete 25-image MailStack UI and logo reference archive as `MAILSTACK-UI-DESIGN-INTAKE-001`.
10+
- Frozen `MAILSTACK-UI-FOUNDATION-001` with screen classification, component, responsive, accessibility, future-roadmap, and implementation-status specifications.
11+
- Added immutable design-asset hashing, PNG integrity validation, deterministic manifest synchronization, contract tests, CI gates, and forensic-audit integration.
12+
- Optimized deterministic source packaging by storing already-compressed media without redundant DEFLATE work.
913
- Adopted **MailStack** as the public open-source project name.
1014
- Set `https://github.com/vibtools/MailStack` as the canonical repository.
1115
- Rebuilt the root README with SEO-oriented positioning for a self-hosted mail server and shared team inbox.

CONTRIBUTING.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,16 @@ The full gate runs tests, coverage, Ruff, Bandit, Django checks, contact-service
4949

5050
## Documentation-first phase workflow
5151

52+
UI work must begin from the frozen design intake and shared foundation. Preserve original PNGs,
53+
update `design/DESIGN_MANIFEST.json` only through the maintained workflow, implement one page per
54+
reviewed patch, and do not activate planned controls without an approved backend/security phase.
55+
Run `python scripts/manage_designs.py --root . check` and `python scripts/test_designs.py`.
56+
5257
Start a maintained phase before implementation:
5358

5459
```bash
5560
python scripts/manage_documents.py new-phase \
56-
--phase-id PHASE-001 \
61+
--phase-id PHASE-002 \
5762
--title "Feature title" \
5863
--summary "What the phase changes for users"
5964
```

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,8 @@ python scripts/check_documentation_policy.py --base HEAD^ --head HEAD
200200
Run the complete repository gate from the project root:
201201

202202
```bash
203+
python scripts/manage_designs.py --root . check
204+
python scripts/test_designs.py
203205
python scripts/forensic_audit.py --root . --full
204206
```
205207

@@ -262,6 +264,9 @@ See [docs/SCREENSHOTS.md](docs/SCREENSHOTS.md) for the approved screenshot set a
262264
| Bootstrap audit | [docs/MAILSTACK_BOOTSTRAP_AUDIT.md](docs/MAILSTACK_BOOTSTRAP_AUDIT.md) |
263265
| GitHub metadata | [docs/GITHUB_REPOSITORY_METADATA.md](docs/GITHUB_REPOSITORY_METADATA.md) |
264266
| First commit from Windows | [docs/FIRST_COMMIT_WINDOWS.md](docs/FIRST_COMMIT_WINDOWS.md) |
267+
| UI design intake | [design/README.md](design/README.md) |
268+
| UI foundation | [documents/design/UI_FOUNDATION.md](documents/design/UI_FOUNDATION.md) |
269+
| UI screen catalog | [documents/design/SCREEN_CATALOG.md](documents/design/SCREEN_CATALOG.md) |
265270

266271
## Roadmap
267272

ROADMAP.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ This roadmap is directional. Security, data integrity and backward compatibility
1818
- Require a phase record, changelog update and affected user-guide update with maintained feature changes
1919
- Keep the generated user-document index and manifest deterministic and CI-enforced
2020

21+
## UI design baseline
22+
23+
- Preserve `MAILSTACK-UI-DESIGN-INTAKE-001` and `MAILSTACK-UI-FOUNDATION-001` as the approved visual reference baseline
24+
- Implement one existing page per reviewed patch after shared foundation work
25+
- Keep planned and future-review screens inactive until architecture and security phases approve them
26+
- Require responsive, accessibility, security, regression, documentation and CI evidence for each page
27+
2128
## 1.3 stable
2229

2330
- Promote the verified release candidate without feature removal

0 commit comments

Comments
 (0)