Skip to content

docs: migrate to v2 doc-metadata cover-page convention#2

Merged
abitofhelp merged 1 commit into
mainfrom
doc-metadata-v2
Apr 27, 2026
Merged

docs: migrate to v2 doc-metadata cover-page convention#2
abitofhelp merged 1 commit into
mainfrom
doc-metadata-v2

Conversation

@abitofhelp
Copy link
Copy Markdown
Owner

Summary

Apply the v2 documentation metadata convention across all markdown docs in this repo.

New cover-page header shape:

**Doc Version:** 3.0.3<br>
**Applies to tzif_ada:** ^3.0<br>
**Last Updated:** 2026-04-26<br>

Changes

  • 8 markdown files: legacy **Version:** / **Date:** header rewritten to v2 canonical form with explicit <br> line breaks; copyright bumped to 2026.
  • Includes docs/formal/software_{design_specification,requirements_specification,test_plan}.md (still markdown — Typst migration is a separate slice for this repo).

Notes

Pattern validated previously on functional, hybrid_lib_ada, hybrid_app_ada. Bundled rollout — no per-repo GPT review.

Refs: adafmt#23

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 <br> 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 <project>: release-process default in caret form (^3.0)
- Last Updated: release-touch date (refreshed today)

Refs: adafmt#23
@abitofhelp abitofhelp merged commit 886cf09 into main Apr 27, 2026
@abitofhelp abitofhelp deleted the doc-metadata-v2 branch April 27, 2026 05:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant