Skip to content

Commit e236d34

Browse files
duyetduyetbot
andauthored
fix(okf): satisfy super-linter markdown rules (#78)
- MD034: wrap bare source URL in angle brackets (SPEC.md) - MD040: add language to two directory-tree fences (text) (SPEC.md) - MARKDOWN_PRETTIER: apply prettier formatting to SKILL.md and SPEC.md Co-authored-by: duyetbot <duyetbot@users.noreply.github.com>
1 parent 97b7324 commit e236d34

2 files changed

Lines changed: 43 additions & 38 deletions

File tree

okf/skills/okf/SKILL.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ When asked to init/scaffold an OKF bundle at `<path>`:
5858

5959
# <Bundle name>
6060

61-
* [Datasets](datasets/) - <group description>
62-
* [Tables](tables/) - <group description>
61+
- [Datasets](datasets/) - <group description>
62+
- [Tables](tables/) - <group description>
6363
```
6464

6565
4. Add a `references/` directory only if you expect standalone citation docs.
@@ -73,28 +73,29 @@ asset name where possible.
7373

7474
```markdown
7575
---
76-
type: <Type name> # REQUIRED — e.g. "BigQuery Table", "API Endpoint", "Playbook"
77-
title: <Display name> # strongly recommended
78-
description: <one-line summary> # strongly recommended — used in indexes/previews
79-
resource: <canonical URI> # for assets that have one
80-
tags: [<tag>, <tag>] # optional, cross-cutting
81-
timestamp: <ISO 8601> # optional, last meaningful change
76+
type: <Type name> # REQUIRED — e.g. "BigQuery Table", "API Endpoint", "Playbook"
77+
title: <Display name> # strongly recommended
78+
description: <one-line summary> # strongly recommended — used in indexes/previews
79+
resource: <canonical URI> # for assets that have one
80+
tags: [<tag>, <tag>] # optional, cross-cutting
81+
timestamp: <ISO 8601> # optional, last meaningful change
8282
---
8383

84-
# Schema (when the concept has structured fields — prefer a table)
84+
# Schema (when the concept has structured fields — prefer a table)
8585

86-
| Column | Type | Description |
87-
|--------|------|-------------|
86+
| Column | Type | Description |
87+
| ------ | ---- | ------------------------------ |
8888
| ... | ... | FK to [other](/group/other.md) |
8989

90-
# Examples (concrete usage in code blocks)
90+
# Examples (concrete usage in code blocks)
9191

92-
# Citations (external sources)
92+
# Citations (external sources)
9393

9494
[1] [Title](https://example.com)
9595
```
9696

9797
Guidance:
98+
9899
- Prefer structural markdown (tables, lists, code blocks) over prose paragraphs.
99100
- Express relationships by **linking** related concepts inline in the prose; the
100101
link is an undirected edge in the knowledge graph.
@@ -109,8 +110,8 @@ pull each bullet's description from the linked concept's `description`:
109110
```markdown
110111
# Tables
111112

112-
* [Orders](orders.md) - one row per completed customer order
113-
* [Customers](customers.md) - one row per customer
113+
- [Orders](orders.md) - one row per completed customer order
114+
- [Customers](customers.md) - one row per customer
114115
```
115116

116117
Use relative links inside an index (they sit beside their targets). Regenerate the
@@ -124,7 +125,8 @@ Append directory-level history, newest first, ISO dates:
124125
# Directory Update Log
125126

126127
## 2026-06-14
127-
* **Creation**: Added orders and customers tables.
128+
129+
- **Creation**: Added orders and customers tables.
128130
```
129131

130132
## Validate a bundle for OKF v0.1 conformance
@@ -136,7 +138,7 @@ check, then eyeball the report. It verifies:
136138
- `index.md` / `log.md` carry no frontmatter (root `index.md` may carry only
137139
`okf_version`).
138140
- Reports broken bundle-relative cross-links as warnings (broken links are
139-
*tolerated* by the spec — surface them, don't fail on them).
141+
_tolerated_ by the spec — surface them, don't fail on them).
140142

141143
```bash
142144
python3 ${CLAUDE_PLUGIN_ROOT}/skills/okf/scripts/validate_okf.py ./bundles/my_bundle

okf/skills/okf/reference/SPEC.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
> anyone can consume it (file servers, Obsidian/Notion/MkDocs, LLMs, search
77
> indexes, graph viewers).
88
>
9-
> Source: https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md
9+
> Source: <https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md>
1010
1111
## Core principles
1212

@@ -26,7 +26,7 @@
2626

2727
A knowledge bundle is a hierarchical directory of markdown files:
2828

29-
```
29+
```text
3030
bundle_root/
3131
├── index.md (optional; only place frontmatter is allowed in an index)
3232
├── log.md (optional)
@@ -38,6 +38,7 @@ bundle_root/
3838
```
3939

4040
**Reserved filenames:**
41+
4142
- `index.md` — progressive-disclosure directory listings.
4243
- `log.md` — chronological update history.
4344

@@ -51,12 +52,12 @@ Two sections: required YAML frontmatter, then a markdown body.
5152

5253
```yaml
5354
---
54-
type: <Type name> # REQUIRED — non-empty string
55-
title: <Display name> # Recommended
56-
description: <One-line summary> # Recommended
57-
resource: <Canonical URI> # Recommended for assets
58-
tags: [<tag>, <tag>] # Optional
59-
timestamp: <ISO 8601 datetime> # Optional
55+
type: <Type name> # REQUIRED — non-empty string
56+
title: <Display name> # Recommended
57+
description: <One-line summary> # Recommended
58+
resource: <Canonical URI> # Recommended for assets
59+
tags: [<tag>, <tag>] # Optional
60+
timestamp: <ISO 8601 datetime> # Optional
6061
# Producers may add arbitrary custom keys.
6162
---
6263
```
@@ -78,11 +79,11 @@ on round-trips.
7879
Standard markdown. Conventional section headings (prefer structural markdown —
7980
tables, lists, code blocks — over prose):
8081

81-
| Section | Purpose |
82-
|---------------|-----------------------------------------------|
83-
| `# Schema` | Structured description of columns/fields. |
84-
| `# Examples` | Concrete usage examples in code blocks. |
85-
| `# Citations` | External sources supporting claims. |
82+
| Section | Purpose |
83+
| ------------- | ----------------------------------------- |
84+
| `# Schema` | Structured description of columns/fields. |
85+
| `# Examples` | Concrete usage examples in code blocks. |
86+
| `# Citations` | External sources supporting claims. |
8687

8788
## Cross-linking
8889

@@ -102,12 +103,12 @@ Optional, support progressive disclosure. Sections group concepts. No frontmatte
102103
```markdown
103104
# Section Heading
104105

105-
* [Title](relative-url) - description from the linked concept
106-
* [Subdirectory](subdir/) - group description
106+
- [Title](relative-url) - description from the linked concept
107+
- [Subdirectory](subdir/) - group description
107108

108109
# Another Section
109110

110-
* [Title](url) - description
111+
- [Title](url) - description
111112
```
112113

113114
Producers may generate them automatically; consumers may synthesize dynamically.
@@ -121,11 +122,13 @@ Date headings must use ISO 8601 `YYYY-MM-DD`. Leading bold words are conventiona
121122
# Directory Update Log
122123

123124
## 2026-05-22
124-
* **Update**: Description of change
125-
* **Creation**: Description of new content
125+
126+
- **Update**: Description of change
127+
- **Creation**: Description of new content
126128

127129
## 2026-05-15
128-
* **Initialization**: Foundational changes
130+
131+
- **Initialization**: Foundational changes
129132
```
130133

131134
## Citations
@@ -166,7 +169,7 @@ Best-effort consumption is preferred over rejection.
166169

167170
## Minimal example
168171

169-
```
172+
```text
170173
my_bundle/
171174
├── index.md
172175
├── datasets/
@@ -209,7 +212,7 @@ timestamp: 2026-05-28T00:00:00Z
209212
# Schema
210213

211214
| Column | Type | Description |
212-
|---------------|---------|------------------------------------------|
215+
| ------------- | ------- | ---------------------------------------- |
213216
| `order_id` | STRING | Unique order identifier. |
214217
| `customer_id` | STRING | FK to [customers](/tables/customers.md). |
215218
| `total_usd` | NUMERIC | Order total in USD. |

0 commit comments

Comments
 (0)