Software engineering requirements specification

Document type: Formal software engineering requirements (platform & delivery) · Audience: Engineering leadership, DevOps, security · Related: Executive overview

1. Repository & branching

• Primary branch: main; protected merges recommended.
• Site root: index.html, styles/, scripts/, mockups/, documents/. Primary formal docs are the executive overview, this specification, and the design guide; older drafts live under Archived documents.
• All deployable assets must be committed; no build-time secrets in client-side bundles.

2. Hosting & canonical URL

• Canonical public URL: https://sqazi.sh/vst-ui/
• Implement via GitHub Pages, reverse proxy, or equivalent static host; TLS required.
• Ensure path prefix /vst-ui/ resolves correctly for relative links (styles/, scripts/, mockups/, documents/).
• If host differs from canonical, set rel="canonical" on index.html (already present).

3. Security

• Static content only; no server-side execution in this repo’s published surface.
• Subresource integrity optional for third-party fonts (currently external TTF URLs—evaluate self-hosting for supply-chain hardening).
• Repository access: least privilege; audit who can push to main.

4. Performance & reliability

• Target: first paint under typical mobile conditions; minimize blocking font loads or self-host WOFF2.
• Caching: long-cache static assets with versioned filenames if build pipeline is introduced later.
• Monitoring: uptime check on canonical URL; alert on TLS/DNS failure.

5. Disaster recovery

• Full site recoverable from Git; document deploy procedure in runbook.
• DNS records for sqazi.sh documented outside this file (internal wiki).

6. Future infrastructure (out of current scope)

A production VST or companion backend would imply code signing, update channels, crash/analytics pipelines, and secrets management—none of which apply to this static mockups site until explicitly chartered.

Related: Executive overview · Design guide · docs/REQUIREMENTS.md (repo)