This repository was archived by the owner on Sep 28, 2026. It is now read-only.
Repository navigation
docs: cross-link dynamic-workflow test cases into the README [skip ci] - #19
Merged
Merged
Conversation
Point readers at skills/codex-graph/testcases/ and docs/dynamic-workflow-testcase-catalog.md from the surfaces they already use: the Validate section (suite scope was stale: it predated the testcase suite and topology-hint lint), the regression-coverage contribution rule, and the repository layout index. Pure cross-links; no behavior, checker, or CHANGELOG changes.
📝 WalkthroughWalkthroughChangesRegression documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 82-86: Update the README description of
skills/codex-graph/testcases/ to identify the offline harness as shared and
located under the testcases/harness/ directory, rather than implying each case
directory contains its own harness. Preserve the description of the six golden
cases and their bundled files.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+82
to
+86
| `skills/codex-graph/testcases/` holds six golden cases derived from real | ||
| orchestration shapes. Each case bundles a synthetic `GOAL.md`, a | ||
| machine-checkable `EXPECTATIONS.md`, and a `topology.hint.mmd`, plus an | ||
| offline harness that can statically check a generated `workflow.js` against a | ||
| case: |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Describe the offline harness as shared.
The command below places check_workflow.js under skills/codex-graph/testcases/harness/, not under each case directory. Revise this sentence so readers do not search for a harness inside every cases/<id>/ directory.
Proposed wording
-Each case bundles a synthetic `GOAL.md`, a
-machine-checkable `EXPECTATIONS.md`, and a `topology.hint.mmd`, plus an
-offline harness that can statically check a generated `workflow.js` against a
-case:
+Each case bundles a synthetic `GOAL.md`, a
+machine-checkable `EXPECTATIONS.md`, and a `topology.hint.mmd`. The shared
+offline harness can statically check a generated `workflow.js` against a case:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| `skills/codex-graph/testcases/` holds six golden cases derived from real | |
| orchestration shapes. Each case bundles a synthetic `GOAL.md`, a | |
| machine-checkable `EXPECTATIONS.md`, and a `topology.hint.mmd`, plus an | |
| offline harness that can statically check a generated `workflow.js` against a | |
| case: | |
| Each case bundles a synthetic `GOAL.md`, a | |
| machine-checkable `EXPECTATIONS.md`, and a `topology.hint.mmd`. The shared | |
| offline harness can statically check a generated `workflow.js` against a case: |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 82 - 86, Update the README description of
skills/codex-graph/testcases/ to identify the offline harness as shared and
located under the testcases/harness/ directory, rather than implying each case
directory contains its own harness. Preserve the description of the six golden
cases and their bundled files.
1 of 3 tasks
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What
Docs-only cross-links for the PR #16 material (
skills/codex-graph/testcases/,docs/dynamic-workflow-testcase-catalog.md) into the surfaces readers already use — the new files were reachable only by directory browsing:run_regressions.shsteps 4–5); now names the dynamic-workflow testcase suite and topology-hint lint, and the coverage sentence includes the three pattern-derived collection scenarios. Added a short "Dynamic-workflow test cases" subsection with thecheck_workflow.jsone-liner and pointers totestcases/README.md(expectation semantics) and the catalog doc (source survey, tier/contract mapping).testcases/cases/as an alternative to atask_collection_harness.test.jsscenario.skills/codex-graph/testcases/,docs/dynamic-workflow-testcase-catalog.md).Verified the new docs' own path references: neither file uses markdown links; all backticked repo-root paths resolve on main @
c27a4d4.Regression coverage
None added — documentation-only change (per the template's doc-only exception). Full suite run locally before push:
sh scripts/run_regressions.sh→ validator PASS, selfcheck PASS, 17/17 collection tests, 19/19 testcase tests, hint lint PASS, release tests OK.Merge note
Keep
[skip ci]in the squash subject to avoid a spurious patch release for a docs change. Deliberately does not touchSKILL.mdorreferences/(sibling PRs #17/#18 own those hunks).Note
Low Risk
Documentation-only README edits with no runtime, skill, or workflow behavior changes.
Overview
Cross-links the existing
skills/codex-graph/testcases/anddocs/dynamic-workflow-testcase-catalog.mdmaterial into the main README so readers do not have to discover them by browsing directories.The Validate section now matches what
run_regressions.shactually runs: dynamic-workflow test cases with topology-hint lint, plus pattern-derived collection scenarios in the suite description. A new Dynamic-workflow test cases subsection gives thecheck_workflow.jsone-liner and points totestcases/README.mdand the catalog doc.Add regression coverage now lists adding a golden case under
testcases/cases/as an alternative totask_collection_harness.test.js. Repository layout gains two index bullets for the testcase tree and catalog doc.Reviewed by Cursor Bugbot for commit 20604ac. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit