Changelog

Track notable changes to the TankSafe portal, backend, and documentation. Each entry should reference the release date, environments affected, and links to PRs or tickets.

2025-10-15 — Administration documentation & build fixes

Highlights

• Comprehensive administration handbook covering job management, scheduling, user administration, and system settings
• Created 23 placeholder SVG images for visual documentation elements
• Resolved Docusaurus build errors by ensuring all referenced images exist

Technical changes

• Portal: No application code changes.
• Backend: No schema or edge-function updates.
• Docs:
  • Completely rebuilt user-guides/admin/administration with detailed workflows and 23 placeholder images
  • Created placeholder SVG files in static/img/ for all referenced screenshots
  • Fixed build compilation errors caused by missing image references
  • Added comprehensive coverage of admin dashboard, job management, user administration, and scheduling features

Actions required

• Replace placeholder images with actual screenshots from the Tank Safe IMS application
• Review administration guide with admin users for completeness and accuracy
• Update any internal references to point to the new administration documentation

2025-10-15 — Integrations documentation expansion

Highlights

• Comprehensive rewrite of the integrations documentation to reflect current capabilities vs. planned features
• Clear separation between implemented admin API functions and roadmap items
• Added practical examples for current integration capabilities
• Enhanced security and implementation guidance for future integrations

Technical changes

• Portal: No application code changes.
• Backend: No schema or edge-function updates.
• Docs:
  • Completely rebuilt technical-guides/integrations with current state assessment
  • Documented existing admin API functions (user management, MFA, invitations)
  • Added detailed roadmap for webhooks, exports, and REST API features
  • Included security considerations and implementation guidance
  • Added troubleshooting section for integration issues
  • Provided practical code examples for current capabilities

Actions required

• Review integration roadmap with development team for prioritization
• Update any internal documentation referencing the old integrations page
• Share updated integrations guide with potential integration partners

2025-10-12 — Portal docs & workflow polish

Highlights

• Expanded onboarding and workflow guides with clearer step-by-step directions and contextual tips.
• Embedded live code excerpts in the architecture overview so engineers can cross-reference implementation details quickly.
• Refreshed documentation styling to make note callouts and troubleshooting sections easier to scan.
• Introduced a dedicated development & deployment workflow guide with diagrams, checklists, and rollback procedures.

Technical changes

• Portal: No application code changes.
• Backend: No schema or edge-function updates.
• Docs:
  • Updated user-guides/getting-started with richer inspection guidance, offline/attachment tips, and direct app-store links for authenticator setup.
  • Reworked user-guides/dashboard visuals and tips, including side-by-side action buttons and refreshed troubleshooting callouts.
  • Revised user-guides/account-management to clarify admin-driven password resets and emphasise MFA requirements at each sign-in.
  • Tuned user-guides/running-inspections troubleshooting guidance and wrapped tips in consistent admonitions.
  • Enhanced technical-guides/architecture with code snippets from tank-wise-portal illustrating routing, auth, edge functions, wizard configuration, and domain models.
    • Added technical-guides/development-deployment-workflow detailing branch strategy, Vercel environments, Supabase migrations, and rollback paths, and refreshed the architecture overview to show GitHub + Vercel topology plus a deployment surface section.
  • Adjusted src/css/custom.css so :::note blocks adopt a TankSafe-themed palette in light and dark modes and updated tip usage across technical guides.

Actions required

• Share the updated getting-started and dashboard guides with onboarding teams.
• Capture current UI screenshots to replace any remaining placeholders when ready.
• Confirm brand review of the new note styling before rolling out broader colour updates.

2025-10-12 — Release readiness reinforcement

Highlights

• Added comprehensive release readiness checklist covering ownership, staged gates, and go/no-go workflows.
• Documented required artifacts, communication planning, and automation hooks for consistent launches.

Technical changes

• Portal: No code changes in this batch.
• Backend: No schema or edge-function updates.
• Docs:
  • Added operations/release-readiness-checklist covering pre-flight gates and go/no-go workflow.
  • Added technical-guides/pdf-style-guide codifying branding, layout, and accessibility requirements.
  • Added operations/support-escalation-scripts with channel-specific incident macros.
  • Added operations/communication-template-library for planned maintenance, releases, and compliance updates.
  • Added operations/kiosk-signage-pack with print specs, QR code guidance, and safety signage copy.
  • Added operations/operator-troubleshooting-tree to guide frontline triage and escalation context.
  • Added technical-guides/integration-certification-checklist covering partner requirements and test evidence.
  • Added operations/executive-summary-playbook detailing monthly leadership reporting cadence.
  • Added user-guides/admin/operations-center outlining daily admin monitoring workflows.
  • Added user-guides/admin/data-governance for audit readiness, retention, and reporting cadence.
  • Added user-guides/account-management to cover profile, security, and notification preferences.
  • Added user-guides/supervisor-review documenting the supervisor approval process.
  • Updated user-guides/inspections/offline-sync to clarify current connectivity requirements and roadmap status.

Actions required

• Walk through the new checklist with the release captain ahead of the next production deployment.
• Ensure each release ticket links back to the artifact table and go/no-go status log.
• Update automation tooling to reference the new checklist URL in pipeline gates.

2025-10-11 — Dashboard refresh & user onboarding polish

Highlights

• Reworked the Getting Started guide to focus on end-user steps, adding prerequisite reminders and cleaner language.
• Created dashboards/search placeholders so training teams can swap in real screenshots without editing Markdown.
• Adjusted the navigation so Dashboard & Global Search now sits directly beneath Getting Started in the user guides sidebar.

Technical changes

• Portal: No code changes.
• Backend: No schema or function updates.
• Docs:
  • Updated user-guides/getting-started with user-facing wording and instructions.
  • Rewrote user-guides/dashboard for non-technical readers and embedded six new placeholder images covering tiles, actions, quick search, full search filters/results, and inspector jobs.
  • Added SVG placeholders under static/img/ for the new dashboard and search visuals.
  • Rewrote user-guides/account-management with step-by-step end-user guidance, troubleshooting tips, and placeholder imagery.
  • Added SVG placeholders under static/img/ for the account password reset, MFA setup, and sign-out screens.
  • Rewrote user-guides/running-inspections to focus on the operator workflow, saving progress, and troubleshooting guidance with new images.
  • Added SVG placeholders under static/img/ for the inspection wizard start, step, and completion screens.
  • Rewrote user-guides/inspector-jobs with step-by-step instructions, refreshed troubleshooting, and new imagery.
  • Added SVG placeholders under static/img/ for the Inspector Jobs overview, filter bar, and row actions.
  • Moved Account Management & Security down the sidebar by changing its sidebar_position so Dashboard appears immediately after Getting Started.

Actions required

• Capture production screenshots and replace the placeholder SVGs in static/img/ once available.
• Share the updated Getting Started guide with onboarding leads so training decks stay aligned.

2025-10-11 — Documentation foundations

• Introduced documentation style guide, glossary, and operator/admin handbooks.
• Updated architecture, deployment, and integrations guides to reflect Supabase/Vercel stack.
• Added troubleshooting playbook and changelog skeleton.
• Improved doc-site authentication flow and login experience.

2025-10-11 — Operational playbooks & integrations

Highlights

• Published end-to-end operational docs: Incident Response, Support Playbook & SLAs, Business Continuity, and Change Management templates.
• Added onboarding, accessibility, and privacy guides to support customer launches and compliance reviews.
• Expanded technical coverage with performance benchmarks, QA/testing strategy, and integration cookbook.

Technical changes

• Portal: No code changes in this release.
• Backend: No schema or edge-function changes.
• Docs: Added incident-response, customer-onboarding, accessibility-ux, data-privacy, performance-benchmarks, support-playbook, change-management, integration-cookbook, qa-testing, business-continuity, mobile-best-practices, security-hardening, and analytics-reporting pages with cross-links and screenshot TODO markers.

Actions required

• Review new operational runbooks with support and on-call teams.
• Share onboarding materials with upcoming customer launches.
• Use the integration cookbook as a baseline for partner implementations.

Template for future entries

## YYYY-MM-DD — <Release name>

### Highlights
-
-
-

### Technical changes
-- Portal: <summary/PR links>
-- Backend: <summary>
-- Docs: <summary>

### Actions required
-- <Item>
-- <Item>

### Screenshots
<!-- TODO: Add screenshot of <feature> -->