Repository navigation
refactor(okf): split skill spec, rename TEMPLATE to SAMPLE, tighten wiki reliability #879
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
295b074
refactor(okf): split spec reference out of SKILL.md, rename TEMPLATE …
yxtay 769e6a7
docs(agents): rename Global Knowledge to Knowledge Wiki, move bundle …
yxtay d78487d
feat(wiki): make write/search rules explicit, grant opencode wiki access
yxtay c871bd3
fix: apply megalinter fixes
yxtay 5b97e7b
Update AGENTS.md
yxtay File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Bundle Update Log | ||
|
|
||
| ## 2026-05-28 | ||
|
|
||
| * **Creation**: Established the [orders](./tables/orders.md) and | ||
| [customers](./tables/customers.md) tables. | ||
|
|
||
| ## 2026-04-12 | ||
|
|
||
| * **Creation**: Added the [freshness alert | ||
| playbook](./playbooks/data-freshness-alert.md). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # OKF Spec Reference | ||
|
|
||
| Field-level detail for [SKILL.md](SKILL.md). Source: OKF v0.1 (Draft, | ||
| [GoogleCloudPlatform/knowledge-catalog](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md)). | ||
|
|
||
| ## Concept frontmatter fields | ||
|
|
||
| Recommended fields, in priority order when trimming: | ||
|
|
||
| | Field | Required | Meaning | | ||
| | ------------- | -------- | ----------------------------------------------- | | ||
| | `type` | **yes** | Free-text kind. Not centrally registered. | | ||
| | `title` | no | Display name; derives from filename if omitted. | | ||
| | `description` | no | One sentence; feeds index entries and search. | | ||
| | `resource` | no | Canonical URI of the underlying asset. | | ||
| | `tags` | no | List for cross-cutting categorization. | | ||
| | `timestamp` | no | ISO 8601 datetime of last meaningful change. | | ||
|
|
||
| `resource` is omitted for abstract concepts (playbooks, decisions, notes) — | ||
| it exists for concepts describing a concrete addressable asset (a table, an | ||
| endpoint). | ||
|
|
||
| Extra producer-defined keys are always allowed — preserve them, never strip | ||
| an unrecognized key. | ||
|
|
||
| Conventional body headings: `# Schema` (columns/fields of a data asset), | ||
| `# Examples` (usage), `# Citations` (see below). | ||
|
|
||
| ## `index.md` | ||
|
|
||
| Progressive disclosure for a directory: a flat, headed list of links to its | ||
| concepts and subdirectories, each with a short description pulled from the | ||
| linked concept's frontmatter. May exist at any directory level, including | ||
| bundle root. | ||
|
|
||
| No frontmatter — **except** the bundle-root `index.md`, which may carry a | ||
| frontmatter block containing only `okf_version` (see Versioning below). | ||
| That is the one place frontmatter is permitted in an `index.md`. | ||
|
|
||
| ## `log.md` | ||
|
|
||
| Optional at any directory level; records that scope's change history as a | ||
| flat, date-grouped list, **newest date first**, headings in `## YYYY-MM-DD` | ||
| form. The leading bold word per entry (`**Update**`, `**Creation**`, | ||
| `**Deprecation**`) is convention, not required structure. | ||
|
|
||
| ## Citations | ||
|
|
||
| When a concept's body makes claims sourced from external material, list | ||
| them under a trailing `# Citations` heading, numbered. Targets may be | ||
| external URLs, bundle-relative paths, or paths into a `references/` | ||
| subdirectory that mirrors external material as first-class concepts. | ||
|
|
||
| ## Versioning | ||
|
|
||
| Format `<major>.<minor>`; this spec is `0.1`. Minor bump = | ||
| backward-compatible addition (new optional field, new conventional | ||
| heading). Major bump = breaking (renamed required field, changed reserved | ||
| filename). Declare a bundle's target version only via `okf_version` in the | ||
| bundle-root `index.md` frontmatter — see [SAMPLE/index.md](SAMPLE/index.md). |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.