Skip to content

[codex] Clarify harness profile and provenance docs - #23

Open
BruceL017 wants to merge 1 commit into
pumblus:mainfrom
BruceL017:codex/document-harness-contracts
Open

[codex] Clarify harness profile and provenance docs#23
BruceL017 wants to merge 1 commit into
pumblus:mainfrom
BruceL017:codex/document-harness-contracts

Conversation

@BruceL017

Copy link
Copy Markdown

Summary

  • Add Harness profile and citation/provenance docs that separate portable OKF bundle conventions from Harness workspace support files.
  • Add a compact data analytics example workspace with dataset, table, metric, relationship, reference, manifest, and raw source layers.
  • Clarify that URL source registration records a pointer, not a webpage snapshot, including CLI next-step guidance and a test.

Verification

  • pnpm lint
  • pnpm typecheck
  • pnpm test
  • pnpm build
  • node packages/cli/dist/main.js check --workspace examples/data-analytics-workspace --json
  • node packages/cli/dist/main.js evidence "How do we calculate monthly active buyers?" --workspace examples/data-analytics-workspace --json

@BruceL017
BruceL017 marked this pull request as ready for review June 26, 2026 08:09
@pumblus

pumblus commented Jun 27, 2026

Copy link
Copy Markdown
Owner

@BruceL017 thanks for the PR and for pushing the provenance docs forward. The Harness profile, citations/provenance guidance, and URL-source clarification all fit the current direction: local-first workspaces, explicit source trails, and bounded evidence from synthesized wiki/ content. I do not think this should merge as-is yet, mainly because the new examples/data-analytics-workspace expands the public example surface beyond the current “one small example workspace” scope, and the branch currently has conflicts in docs/WORKFLOWS.md and llms-full.txt.

Could you split this into two PRs? I would be comfortable reviewing the docs/CLI clarification first: docs/HARNESS_PROFILE.md, docs/CITATIONS.md, the URL pointer next-step, the source test, the existing example citation fix, and regenerated llms files after resolving conflicts. The data analytics example looks useful, but I think it should be a separate product-scope decision with its own validation coverage before we add a second maintained public example.

This comment was marked as abuse.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants