From 7e4b2b8f41c7f44ac3b7bac01817542d0dcb7737 Mon Sep 17 00:00:00 2001 From: Michael Gardner Date: Sun, 26 Apr 2026 22:06:20 -0700 Subject: [PATCH] docs: migrate to v2 doc-metadata cover-page convention Apply the v2 documentation metadata convention across all markdown docs: Doc Version / Applies to tzif_ada / Last Updated Changes: - 8 markdown files: legacy "Version:/Date:" header rewritten to v2 canonical form with explicit
line breaks; copyright bumped to 2026 Note: formal docs (SDS/SRS/STP) remain in markdown form in this repo (Typst migration is a separate slice). Field-ownership split per the new convention: - Doc Version: doc-author owned (reset to library version on legacy migration) - Applies to : release-process default in caret form (^3.0) - Last Updated: release-touch date (refreshed today) Refs: adafmt#23 --- README.md | 7 ++++--- docs/formal/software_design_specification.md | 7 ++++--- docs/formal/software_requirements_specification.md | 7 ++++--- docs/formal/software_test_plan.md | 7 ++++--- docs/guides/embedded_platform_guide.md | 7 ++++--- docs/index.md | 7 ++++--- docs/quick_start.md | 7 ++++--- docs/roadmap.md | 7 ++++--- 8 files changed, 32 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 118dcef..8ca892d 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,12 @@ [![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](LICENSE) [![Ada](https://img.shields.io/badge/Ada-2022-blue.svg)](https://ada-lang.io) [![Alire](https://img.shields.io/badge/Alire-2.0+-blue.svg)](https://alire.ada.dev) [![SPARK](https://img.shields.io/badge/SPARK-Proved-green.svg)](https://www.adacore.com/about-spark) -**Version:** 3.0.3
-**Date:** 2025-12-16
+**Doc Version:** 3.0.3
+**Applies to tzif_ada:** ^3.0
+**Last Updated:** 2026-04-26
**SPDX-License-Identifier:** BSD-3-Clause
**License File:** See the LICENSE file in the project root
-**Copyright:** © 2025 Michael Gardner, A Bit of Help, Inc.
+**Copyright:** © 2026 Michael Gardner, A Bit of Help, Inc.
**Status:** Released > **Note**: A companion library providing higher-level functions for working with timezones and durations in Ada 2022 will be released soon. diff --git a/docs/formal/software_design_specification.md b/docs/formal/software_design_specification.md index 73d9ada..55795a8 100644 --- a/docs/formal/software_design_specification.md +++ b/docs/formal/software_design_specification.md @@ -1,10 +1,11 @@ # Software Design Specification (SDS) -**Version:** 3.0.3
-**Date:** 2025-12-16
+**Doc Version:** 3.0.3
+**Applies to tzif_ada:** ^3.0
+**Last Updated:** 2026-04-26
**SPDX-License-Identifier:** BSD-3-Clause
**License File:** See the LICENSE file in the project root
-**Copyright:** © 2025 Michael Gardner, A Bit of Help, Inc.
+**Copyright:** © 2026 Michael Gardner, A Bit of Help, Inc.
**Status:** Released --- diff --git a/docs/formal/software_requirements_specification.md b/docs/formal/software_requirements_specification.md index a79f5da..035bb85 100644 --- a/docs/formal/software_requirements_specification.md +++ b/docs/formal/software_requirements_specification.md @@ -1,10 +1,11 @@ # Software Requirements Specification (SRS) -**Version:** 3.0.3
-**Date:** 2025-12-16
+**Doc Version:** 3.0.3
+**Applies to tzif_ada:** ^3.0
+**Last Updated:** 2026-04-26
**SPDX-License-Identifier:** BSD-3-Clause
**License File:** See the LICENSE file in the project root
-**Copyright:** © 2025 Michael Gardner, A Bit of Help, Inc.
+**Copyright:** © 2026 Michael Gardner, A Bit of Help, Inc.
**Status:** Released --- diff --git a/docs/formal/software_test_plan.md b/docs/formal/software_test_plan.md index a8e02e8..a8cc135 100644 --- a/docs/formal/software_test_plan.md +++ b/docs/formal/software_test_plan.md @@ -1,10 +1,11 @@ # Software Test Plan (STP) -**Version:** 3.0.3
-**Date:** 2025-12-16
+**Doc Version:** 3.0.3
+**Applies to tzif_ada:** ^3.0
+**Last Updated:** 2026-04-26
**SPDX-License-Identifier:** BSD-3-Clause
**License File:** See the LICENSE file in the project root
-**Copyright:** © 2025 Michael Gardner, A Bit of Help, Inc.
+**Copyright:** © 2026 Michael Gardner, A Bit of Help, Inc.
**Status:** Released --- diff --git a/docs/guides/embedded_platform_guide.md b/docs/guides/embedded_platform_guide.md index 0ed1857..aa4414b 100644 --- a/docs/guides/embedded_platform_guide.md +++ b/docs/guides/embedded_platform_guide.md @@ -1,10 +1,11 @@ # Embedded Platform Guide -**Version:** 3.0.3
-**Date:** 2025-12-16
+**Doc Version:** 3.0.3
+**Applies to tzif_ada:** ^3.0
+**Last Updated:** 2026-04-26
**SPDX-License-Identifier:** BSD-3-Clause
**License File:** See the LICENSE file in the project root
-**Copyright:** © 2025 Michael Gardner, A Bit of Help, Inc.
+**Copyright:** © 2026 Michael Gardner, A Bit of Help, Inc.
**Status:** Released --- diff --git a/docs/index.md b/docs/index.md index 5bb734e..a069df5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,11 @@ # TZif Documentation -**Version:** 3.0.3
-**Date:** 2025-12-16
+**Doc Version:** 3.0.3
+**Applies to tzif_ada:** ^3.0
+**Last Updated:** 2026-04-26
**SPDX-License-Identifier:** BSD-3-Clause
**License File:** See the LICENSE file in the project root
-**Copyright:** © 2025 Michael Gardner, A Bit of Help, Inc.
+**Copyright:** © 2026 Michael Gardner, A Bit of Help, Inc.
**Status:** Released --- diff --git a/docs/quick_start.md b/docs/quick_start.md index b35756a..8e41e79 100644 --- a/docs/quick_start.md +++ b/docs/quick_start.md @@ -1,10 +1,11 @@ # TZif Quick Start Guide -**Version:** 3.0.3
-**Date:** 2025-12-16
+**Doc Version:** 3.0.3
+**Applies to tzif_ada:** ^3.0
+**Last Updated:** 2026-04-26
**SPDX-License-Identifier:** BSD-3-Clause
**License File:** See the LICENSE file in the project root
-**Copyright:** © 2025 Michael Gardner, A Bit of Help, Inc.
+**Copyright:** © 2026 Michael Gardner, A Bit of Help, Inc.
**Status:** Released --- diff --git a/docs/roadmap.md b/docs/roadmap.md index 42ecb11..397301e 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -1,10 +1,11 @@ # TZif Development Roadmap -**Version:** 3.0.3
-**Date:** 2025-12-16
+**Doc Version:** 3.0.3
+**Applies to tzif_ada:** ^3.0
+**Last Updated:** 2026-04-26
**SPDX-License-Identifier:** BSD-3-Clause
**License File:** See the LICENSE file in the project root
-**Copyright:** © 2025 Michael Gardner, A Bit of Help, Inc.
+**Copyright:** © 2026 Michael Gardner, A Bit of Help, Inc.
**Status:** Released ---