From f6a6e4123eb680ae45c5912f079b757872fde18f Mon Sep 17 00:00:00 2001 From: Gal Kleinman Date: Wed, 12 Aug 2026 22:47:53 +0300 Subject: [PATCH 1/2] docs: drop disallowed frontmatter from the developer-docs bundle root MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit OKF §8 allows no frontmatter on an index.md, with one exception: a bundle-root index.md may carry okf_version (§12). The five other keys here make developer-docs/ fail §11.3 conformance. Nothing is lost: the body's `# developer-docs` heading and opening line already carry the title and description, and index files are not concept documents, so type/tags/timestamp have no defined meaning on one. --- developer-docs/index.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/developer-docs/index.md b/developer-docs/index.md index 7575c44c..6613cf13 100644 --- a/developer-docs/index.md +++ b/developer-docs/index.md @@ -1,10 +1,5 @@ --- -type: Index -title: developer-docs -description: OKF knowledge bundle entry point for firebaseui-web. -tags: [okf, documentation] okf_version: "0.1" -timestamp: 2026-07-03T00:00:00Z --- # developer-docs From d1b1e4a5b84ca2b1137a99604dfa619956fafed8 Mon Sep 17 00:00:00 2001 From: Gal Kleinman Date: Wed, 12 Aug 2026 22:47:53 +0300 Subject: [PATCH 2/2] ci: validate the developer-docs OKF bundle MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Conformance only (§11): parseable frontmatter, a non-empty type, and the reserved index.md/log.md structure. §11 forbids consumers rejecting a bundle for broken links or missing optional fields, so this cannot fail on those. Scoped by path so it runs only when the bundle changes. --- .github/workflows/developer-docs.yaml | 33 +++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/workflows/developer-docs.yaml diff --git a/.github/workflows/developer-docs.yaml b/.github/workflows/developer-docs.yaml new file mode 100644 index 00000000..00af1f13 --- /dev/null +++ b/.github/workflows/developer-docs.yaml @@ -0,0 +1,33 @@ +name: Developer Docs + +on: + push: + branches: + - main + paths: + - 'developer-docs/**' + - '.github/workflows/developer-docs.yaml' + pull_request: + paths: + - 'developer-docs/**' + - '.github/workflows/developer-docs.yaml' + +permissions: + contents: read + +jobs: + validate: + name: Validate OKF bundle + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + persist-credentials: false + + - name: Validate developer-docs + uses: galkleinman/okf-toolkit@c7c29e678f37c990fb0b04ca08411bb2e5bdf3bf # v0.2.1 + with: + path: developer-docs + command: validate