Skip to content

Commit d474de2

Browse files
committed
📝 [docs] Updates doc front matter metadata
📝 [docs] Replaces reserved front‑matter fields with doc‑specific metadata across docs and guidance to avoid TypeDoc routing side effects, plus refreshes review dates. 🧭 🧹 [chore] Tightens front‑matter schema, validation rules, and serialization order to require the schema reference and new doc metadata fields. ✅ 📝 [docs] Normalizes formatting, list styles, and navigation aids while trimming front‑matter from TSDoc tag pages. 📚 🔧 [build] Expands TypeDoc markdown generation options and adjusts link validation and Docusaurus warning behavior for docs builds. 🧰 Signed-off-by: Nick2bad4u <20943337+Nick2bad4u@users.noreply.github.com>
1 parent 244a289 commit d474de2

139 files changed

Lines changed: 1183 additions & 1199 deletions

File tree

Some content is hidden

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

.github/Markdown.instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ Follow these guidelines for formatting and structuring your markdown content:
2727

2828
- **Front Matter**: Use `---` to delimit YAML front matter when a file needs metadata.
2929
- In general markdown files (e.g. `README.md` at the repo root), choose fields that are useful to readers and tooling.
30-
- For documentation pages under `docs/**`, follow the schema in `config/schemas/doc-frontmatter.schema.json` and keep fields (such as `title`, `summary`, `category`, and `tags`) valid per that schema. Use `scripts/validate-doc-frontmatter.mjs` and the `docs:validate:frontmatter` / `docs:check` scripts to verify correctness.
30+
- For documentation pages under `docs/**`, follow the schema in `config/schemas/doc-frontmatter.schema.json` and keep fields (such as `doc_title`, `summary`, `doc_category`, and `tags`) valid per that schema. (We intentionally avoid TypeDoc-reserved keys like `title`/`category`/`group` in this repo's docs frontmatter.) Use `scripts/validate-doc-frontmatter.mjs` and the `docs:validate:frontmatter` / `docs:check` scripts to verify correctness.
3131
- **Metadata**: Ensure that metadata is accurate and up to date. When a document uses front matter, update date or version fields when content meaningfully changes.
3232
- **Tooling alignment**: The repository enforces Markdown style via Remark (`.remarkrc.mjs`). Run `npm run remark:check` (or `npm run docs:check` for doc bundles) before committing to catch lint issues.

config/schemas/doc-frontmatter.schema.json

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"$id": "https://uptime-watcher.dev/schemas/doc-frontmatter.schema.json",
33
"$schema": "https://json-schema.org/draft/2020-12/schema",
44
"additionalProperties": false,
5-
"description": "Schema for YAML front-matter used in Uptime Watcher Markdown guides (e.g. docs/Guides/*.md).",
5+
"description": "Schema for YAML front-matter used in Uptime Watcher Markdown guides (e.g. docs/Guides/*.md). NOTE: This schema intentionally avoids TypeDoc-reserved keys (title/category/group) because TypeDoc's external-documents frontmatter handling can change output routing when those keys are present.",
66
"properties": {
77
"$schema": {
88
"description": "Optional JSON Schema reference used by editors to validate front matter.",
@@ -23,16 +23,26 @@
2323
"minLength": 1,
2424
"type": "string"
2525
},
26-
"category": {
27-
"description": "Coarse document type; currently always 'guide' for docs/Guides/*.md.",
28-
"enum": ["guide"],
29-
"type": "string"
30-
},
3126
"created": {
3227
"description": "Date the document was originally created (YYYY-MM-DD), usually from git log.",
3328
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
3429
"type": "string"
3530
},
31+
"doc_category": {
32+
"description": "Coarse document type; currently always 'guide' for docs/Guides/*.md. Named 'doc_category' to avoid TypeDoc frontmatter routing side-effects.",
33+
"enum": ["guide"],
34+
"type": "string"
35+
},
36+
"doc_group": {
37+
"description": "Optional grouping label for internal tooling. Named 'doc_group' to avoid TypeDoc frontmatter routing side-effects.",
38+
"minLength": 1,
39+
"type": "string"
40+
},
41+
"doc_title": {
42+
"description": "Human-friendly document title (usually matches the H1). Named 'doc_title' to avoid TypeDoc frontmatter routing side-effects.",
43+
"minLength": 1,
44+
"type": "string"
45+
},
3646
"last_reviewed": {
3747
"description": "Date the content was last reviewed/updated (YYYY-MM-DD).",
3848
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
@@ -67,11 +77,6 @@
6777
"type": "array",
6878
"uniqueItems": true
6979
},
70-
"title": {
71-
"description": "Human-friendly document title (usually matches the H1).",
72-
"minLength": 1,
73-
"type": "string"
74-
},
7580
"topics": {
7681
"description": "Optional higher-level areas (e.g. monitoring, architecture).",
7782
"items": {
@@ -84,12 +89,13 @@
8489
},
8590
"required": [
8691
"author",
87-
"category",
8892
"created",
93+
"doc_category",
94+
"doc_title",
8995
"last_reviewed",
9096
"summary",
9197
"tags",
92-
"title"
98+
"schema"
9399
],
94100
"title": "Uptime Watcher Documentation Front Matter",
95101
"type": "object"

docs/Architecture/ADRs/ADR_001_REPOSITORY_PATTERN.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
---
22
schema: "../../../config/schemas/doc-frontmatter.schema.json"
3-
title: "ADR-001: Repository Pattern for Database Access"
3+
doc_title: "ADR-001: Repository Pattern for Database Access"
44
summary: "Establishes a repository pattern for all database access with transaction safety, caching, and event-driven hooks."
55
created: "2025-08-05"
6-
last_reviewed: "2025-11-17"
7-
category: "guide"
6+
last_reviewed: "2026-01-31"
7+
doc_category: "guide"
88
author: "Nick2bad4u"
99
tags:
10-
- "uptime-watcher"
11-
- "architecture"
12-
- "adr"
13-
- "database"
14-
- "repository-pattern"
10+
- "uptime-watcher"
11+
- "architecture"
12+
- "adr"
13+
- "database"
14+
- "repository-pattern"
1515
---
16-
1716
# ADR-001: Repository Pattern for Database Access
1817

1918
## Table of Contents

docs/Architecture/ADRs/ADR_002_EVENT_DRIVEN_ARCHITECTURE.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
22
schema: "../../../config/schemas/doc-frontmatter.schema.json"
3-
title: "ADR-002: Event-Driven Architecture with TypedEventBus"
3+
doc_title: "ADR-002: Event-Driven Architecture with TypedEventBus"
44
summary: "Defines an event-driven architecture using a TypedEventBus for decoupled, type-safe communication across backend and frontend."
55
created: "2025-08-05"
66
last_reviewed: "2026-01-11"
7-
category: "guide"
7+
doc_category: "guide"
88
author: "Nick2bad4u"
99
tags:
10-
- "uptime-watcher"
11-
- "architecture"
12-
- "adr"
13-
- "events"
14-
- "typed-event-bus"
15-
- "ipc"
10+
- "uptime-watcher"
11+
- "architecture"
12+
- "adr"
13+
- "events"
14+
- "typed-event-bus"
15+
- "ipc"
1616
---
17-
1817
# ADR-002: Event-Driven Architecture with TypedEventBus
1918

2019
## Table of Contents

docs/Architecture/ADRs/ADR_003_ERROR_HANDLING_STRATEGY.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
---
22
schema: "../../../config/schemas/doc-frontmatter.schema.json"
3-
title: "ADR-003: Comprehensive Error Handling Strategy"
3+
doc_title: "ADR-003: Comprehensive Error Handling Strategy"
44
summary: "Establishes a comprehensive multi-layer error handling strategy with shared utilities, store-safe patterns, and production-grade resilience."
55
created: "2025-08-05"
6-
last_reviewed: "2025-12-11"
7-
category: "guide"
6+
last_reviewed: "2026-01-31"
7+
doc_category: "guide"
88
author: "Nick2bad4u"
99
tags:
10-
- "uptime-watcher"
11-
- "architecture"
12-
- "adr"
13-
- "error-handling"
14-
- "resilience"
10+
- "uptime-watcher"
11+
- "architecture"
12+
- "adr"
13+
- "error-handling"
14+
- "resilience"
1515
---
16-
1716
# ADR-003: Comprehensive Error Handling Strategy
1817

1918
## Table of Contents

docs/Architecture/ADRs/ADR_004_FRONTEND_STATE_MANAGEMENT.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
22
schema: "../../../config/schemas/doc-frontmatter.schema.json"
3-
title: "ADR-004: Frontend State Management with Zustand"
3+
doc_title: "ADR-004: Frontend State Management with Zustand"
44
summary: "Defines the frontend state management strategy using Zustand with modular composition and selective persistence."
55
created: "2025-08-05"
6-
last_reviewed: "2025-12-11"
7-
category: "guide"
6+
last_reviewed: "2025-12-23"
7+
doc_category: "guide"
88
author: "Nick2bad4u"
99
tags:
10-
- "uptime-watcher"
11-
- "architecture"
12-
- "adr"
13-
- "zustand"
14-
- "state-management"
15-
- "frontend"
10+
- "uptime-watcher"
11+
- "architecture"
12+
- "adr"
13+
- "zustand"
14+
- "state-management"
15+
- "frontend"
1616
---
17-
1817
# ADR-004: Frontend State Management with Zustand
1918

2019
## Table of Contents

docs/Architecture/ADRs/ADR_005_IPC_COMMUNICATION_PROTOCOL.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
22
schema: "../../../config/schemas/doc-frontmatter.schema.json"
3-
title: "ADR-005: IPC Communication Protocol"
3+
doc_title: "ADR-005: IPC Communication Protocol"
44
summary: "Defines a standardized, type-safe IPC communication protocol using Electron's contextBridge with validation, error handling, and static guard rails."
55
created: "2025-08-05"
6-
last_reviewed: "2026-01-08"
7-
category: "guide"
6+
last_reviewed: "2026-02-01"
7+
doc_category: "guide"
88
author: "Nick2bad4u"
99
tags:
10-
- "uptime-watcher"
11-
- "architecture"
12-
- "adr"
13-
- "ipc"
14-
- "electron"
15-
- "communication"
10+
- "uptime-watcher"
11+
- "architecture"
12+
- "adr"
13+
- "ipc"
14+
- "electron"
15+
- "communication"
1616
---
17-
1817
# ADR-005: IPC Communication Protocol
1918

2019
## Table of Contents

docs/Architecture/ADRs/ADR_006_STANDARDIZED_CACHE_CONFIGURATION.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
---
22
schema: "../../../config/schemas/doc-frontmatter.schema.json"
3-
title: "ADR-006: Standardized Cache Configuration"
3+
doc_title: "ADR-006: Standardized Cache Configuration"
44
summary: "Defines standardized cache configuration constants and patterns for managers and services to ensure consistent TTLs and limits."
55
created: "2025-08-23"
6-
last_reviewed: "2025-11-17"
7-
category: "guide"
6+
last_reviewed: "2025-12-16"
7+
doc_category: "guide"
88
author: "Nick2bad4u"
99
tags:
10-
- "uptime-watcher"
11-
- "architecture"
12-
- "adr"
13-
- "cache"
14-
- "configuration"
10+
- "uptime-watcher"
11+
- "architecture"
12+
- "adr"
13+
- "cache"
14+
- "configuration"
1515
---
16-
1716
# ADR-006: Standardized Cache Configuration
1817

1918
## Table of Contents

docs/Architecture/ADRs/ADR_007_SERVICE_CONTAINER_DEPENDENCY_INJECTION.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
22
schema: "../../../config/schemas/doc-frontmatter.schema.json"
3-
title: "ADR-007: Service Container and Dependency Injection Pattern"
3+
doc_title: "ADR-007: Service Container and Dependency Injection Pattern"
44
summary: "Establishes a centralized dependency injection container for managing service lifecycles, initialization order, and inter-service communication in the Electron main process."
55
created: "2025-11-25"
6-
last_reviewed: "2025-11-25"
7-
category: "guide"
6+
last_reviewed: "2025-12-17"
7+
doc_category: "guide"
88
author: "Nick2bad4u"
99
tags:
10-
- "uptime-watcher"
11-
- "architecture"
12-
- "adr"
13-
- "dependency-injection"
14-
- "service-container"
15-
- "electron"
10+
- "uptime-watcher"
11+
- "architecture"
12+
- "adr"
13+
- "dependency-injection"
14+
- "service-container"
15+
- "electron"
1616
---
17-
1817
# ADR-007: Service Container and Dependency Injection Pattern
1918

2019
## Table of Contents

docs/Architecture/ADRs/ADR_008_MONITOR_TYPE_REGISTRY.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
22
schema: "../../../config/schemas/doc-frontmatter.schema.json"
3-
title: "ADR-008: Monitor Type Registry and Plugin Architecture"
3+
doc_title: "ADR-008: Monitor Type Registry and Plugin Architecture"
44
summary: "Establishes an extensible plugin-based system for registering monitor types with dynamic validation schemas, UI configuration, service factories, and version tagging (for future migration support)."
55
created: "2025-11-25"
6-
last_reviewed: "2026-01-11"
7-
category: "guide"
6+
last_reviewed: "2026-02-10"
7+
doc_category: "guide"
88
author: "Nick2bad4u"
99
tags:
10-
- "uptime-watcher"
11-
- "architecture"
12-
- "adr"
13-
- "monitor-types"
14-
- "plugin-architecture"
15-
- "extensibility"
10+
- "uptime-watcher"
11+
- "architecture"
12+
- "adr"
13+
- "monitor-types"
14+
- "plugin-architecture"
15+
- "extensibility"
1616
---
17-
1817
# ADR-008: Monitor Type Registry and Plugin Architecture
1918

2019
## Table of Contents

0 commit comments

Comments
 (0)