fix(docs): OKF conformance of developer-docs + CI validation - #1445
Open
galkleinman wants to merge 2 commits into
Open
fix(docs): OKF conformance of developer-docs + CI validation#1445galkleinman wants to merge 2 commits into
galkleinman wants to merge 2 commits into
Conversation
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.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Contributor
There was a problem hiding this comment.
Code Review
This pull request simplifies the frontmatter of the developer-docs/index.md file by removing several metadata fields, including type, title, description, tags, and timestamp, while retaining the okf_version field. There are no review comments, and I have no feedback to provide.
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.
galkleinman
force-pushed
the
fix/okf-bundle-root-index-frontmatter
branch
from
August 12, 2026 19:59
3a68996 to
d1b1e4a
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
developer-docs/does not currently pass OKF v0.1 conformance, so tooling that reads the bundle rejects it before reading any of the content.What fails
Every key on the bundle-root
index.mdexceptokf_version. §8 is explicit that index files carry no frontmatter, with exactly one exception — a bundle-rootindex.mdmay declareokf_version(§12) — and §11.3 makes the reserved-filename structure a conformance requirement:Nothing is lost by removing them. The body's
# developer-docsheading and opening line already carry the title and description, and an index file is not a concept document, sotype,tags, andtimestamphave no defined meaning on one. The rest of the bundle is already conformant — this is the only file that fails.This matches
developer-docs/documentation-policy.md, which requires frontmatter with atypeon concept files and says nothing about index files.CI
Adds
.github/workflows/developer-docs.yaml, running conformance only (§11: parseable frontmatter, non-emptytype, reserved-file structure). §11 forbids consumers from rejecting a bundle for broken cross-links, unknowntypevalues, unknown keys, or missing optional fields, so this gate cannot fail on any of those — it catches the structural breakage above and nothing else. The bundle is also clean of advisory warnings today, if you would rather runcommand: lintinstead.Path-scoped so it runs only when
developer-docs/changes, action pinned by SHA andpermissions: contents: read, matchinglint.yaml.The action is okf-toolkit, Apache-2.0. Happy to swap it for a plain
curl-and-run step, or to drop the CI commit entirely and keep just the fix, whichever you prefer.