Restore the v4 repository foundation - #2399
Conversation
|
4d4d3bf to
9f66fd9
Compare
There was a problem hiding this comment.
1 issue found across 8 files
Confidence score: 5/5
- In
.cubic/docs-style-guide.md, the SDK-page guidance points topackages/docs/scripts/sync-sdk-docs.js, which doesn’t exist yet, so generated findings may be misrouted or dropped and create review noise rather than product regressions — update the reference to the real generator once added, or keep the target path generic for now.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name=".cubic/docs-style-guide.md">
<violation number="1" location=".cubic/docs-style-guide.md:7">
P3: Generated SDK-page findings cannot be routed to the named path because `packages/docs/scripts/sync-sdk-docs.js` does not exist. Use the actual generator when it is added, or describe the target generically so this rule remains actionable.</violation>
</file>
Architecture diagram
sequenceDiagram
participant PR as Contributor
participant GH as GitHub
participant Cubic as Cubic CI
participant Repo as v4-spike Repository
Note over PR,Repo: PR restores top-level v3 foundation files into v4-spike
PR->>GH: Opens PR with 8 restored files
GH->>Repo: Checks CODEOWNERS (/.github/CODEOWNERS)
alt File match: /packages/docs/**
Repo-->>GH: Route review to @browserbase/gtm
end
GH->>Cubic: Triggers Cubic review
alt File path: packages/docs/**
Cubic->>Cubic: Loads custom rules from cubic.yaml
Cubic->>Cubic: Applies docs-style-guide.md rules
Note over Cubic: Blocking rules: prose style, voice,<br/>casing, Oxford comma, etc.
Cubic-->>GH: Review comments on new/modified docs prose
end
Repo-->>GH: Confirms file additions:
Note over Repo: LICENSE (MIT)<br/>CHANGELOG.md (v3 history)<br/>CODEOWNERS<br/>PR template<br/>Bug/Feature templates<br/>cubic.yaml + style guide
GH->>PR: Updates with CI status and review assignments
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
|
|
||
| Apply these rules only to public-facing prose under `packages/docs/**`, including frontmatter descriptions, headings, navigation labels, paragraphs, tables, callouts, and authored code comments. | ||
|
|
||
| Do not apply prose rules to code identifiers, executable code, URLs, copied prompts, sample task strings, configuration examples, or logs. Do not request direct edits to generated SDK pages under `packages/docs/v3/sdk/`; report source-content problems against the owning SDK repository or `packages/docs/scripts/sync-sdk-docs.js`. |
There was a problem hiding this comment.
P3: Generated SDK-page findings cannot be routed to the named path because packages/docs/scripts/sync-sdk-docs.js does not exist. Use the actual generator when it is added, or describe the target generically so this rule remains actionable.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At .cubic/docs-style-guide.md, line 7:
<comment>Generated SDK-page findings cannot be routed to the named path because `packages/docs/scripts/sync-sdk-docs.js` does not exist. Use the actual generator when it is added, or describe the target generically so this rule remains actionable.</comment>
<file context>
@@ -0,0 +1,64 @@
+
+Apply these rules only to public-facing prose under `packages/docs/**`, including frontmatter descriptions, headings, navigation labels, paragraphs, tables, callouts, and authored code comments.
+
+Do not apply prose rules to code identifiers, executable code, URLs, copied prompts, sample task strings, configuration examples, or logs. Do not request direct edits to generated SDK pages under `packages/docs/v3/sdk/`; report source-content problems against the owning SDK repository or `packages/docs/scripts/sync-sdk-docs.js`.
+
+## Scope boundary
</file context>
| Do not apply prose rules to code identifiers, executable code, URLs, copied prompts, sample task strings, configuration examples, or logs. Do not request direct edits to generated SDK pages under `packages/docs/v3/sdk/`; report source-content problems against the owning SDK repository or `packages/docs/scripts/sync-sdk-docs.js`. | |
| Do not apply prose rules to code identifiers, executable code, URLs, copied prompts, sample task strings, configuration examples, or logs. Do not request direct edits to generated SDK pages; report source-content problems against the owning SDK repository or generator. |
1b49c56 to
29e7c4d
Compare
So the
v4-spikebranch that this PR would merge into is the code from thev4-spikerepo. On that branch, I have done only two things exactly:This makes the transition easy to follow. The end goal will be that this
v4-spikerepo gets merged intomainon launch. To do that, we now need to add back in all of the parts of v3 we want, as well as continue to improve v4, in atomic PRs.This PR simply restores the top-level files from v3 that we want to keep directly in v4 (with no changes):
In this stack of PRs, we'll start adding back in the v3 code we want, piece by piece.