docs(registry): document the full dataset workflow#13
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Greptile SummaryThis PR adds All referenced npm scripts (
Confidence Score: 5/5Safe to merge — documentation only, all referenced paths and scripts verified accurate. Every npm script, test file, generated artifact, and workflow reference in the document was verified to exist in the codebase. The single comment flagged is a minor P2 style issue (stale self-referential bullet) that does not affect correctness or behaviour. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Edit registry/datasets.ts] --> B[npm run registry:generate]
B --> C1[api/_generated/dataset-registry.js]
B --> C2[api/_generated/health-registry.js]
B --> C3[server/_shared/_generated/bootstrap-registry.ts]
C1 & C2 & C3 --> D[Commit source + all generated artifacts]
D --> E{Local validation}
E --> E1[npm run registry:check]
E --> E2[node --test tests/bootstrap.test.mjs]
E --> E3[npm run test:data]
E --> E4[npm run typecheck / typecheck:api]
E1 & E2 & E3 & E4 --> F[Open PR]
F --> G{CI - typecheck.yml}
G --> G1[npm run typecheck]
G --> G2[npm run typecheck:api]
G --> G3[npm run registry:check]
Prompt To Fix All With AIThis is a comment left during a code review.
Path: docs/architecture/dataset-registry.md
Line: 57
Comment:
**Self-referential stacked-PR entry becomes stale after merge**
This last bullet refers to the current PR itself, but uses a future tense description and no PR number. After this PR is merged, the sequence reads as if the docs work is still pending and provides no link for readers to follow.
Consider replacing the generic placeholder with the actual PR number and past-tense language (or just remove it, since the doc's own existence completes the work):
```suggestion
- `#13` `docs(registry): document the full dataset workflow`
```
How can I resolve this? If you propose a fix, please make it concise.Reviews (1): Last reviewed commit: "docs(registry): document the registry-fi..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| - `#10` `chore(registry): stabilize dataset contract foundation and bootstrap parity` | ||
| - `#11` `refactor(health): load generated health registry in fork` | ||
| - `#12` `ci(registry): enforce generated registry freshness in fork` | ||
| - docs PR: update the contribution path and validation guidance after the code slices land |
There was a problem hiding this comment.
This last bullet refers to the current PR itself, but uses a future tense description and no PR number. After this PR is merged, the sequence reads as if the docs work is still pending and provides no link for readers to follow.
Consider replacing the generic placeholder with the actual PR number and past-tense language (or just remove it, since the doc's own existence completes the work):
| - docs PR: update the contribution path and validation guidance after the code slices land | |
| - `#13` `docs(registry): document the full dataset workflow` |
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/architecture/dataset-registry.md
Line: 57
Comment:
**Self-referential stacked-PR entry becomes stale after merge**
This last bullet refers to the current PR itself, but uses a future tense description and no PR number. After this PR is merged, the sequence reads as if the docs work is still pending and provides no link for readers to follow.
Consider replacing the generic placeholder with the actual PR number and past-tense language (or just remove it, since the doc's own existence completes the work):
```suggestion
- `#13` `docs(registry): document the full dataset workflow`
```
How can I resolve this? If you propose a fix, please make it concise.
|
@codex review |
|
Codex Review: Didn't find any major issues. Chef's kiss. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Document the generated bootstrap and health artifacts, required validation commands, and the fork-first contribution flow centered on issue #5 plus smaller stacked PRs. Validation: npm run registry:check
Replace the self-referential placeholder in the stacked PR list with the actual docs PR entry so the sequence stays accurate after merge.
lspassos1
force-pushed
the
ci/registry-freshness
branch
from
50e795e to
9c37cfe
Compare
lspassos1
force-pushed
the
docs/dataset-registry-workflow
branch
from
6396820 to
73590e8
Compare
|
PR author is not in the allowed authors list. |
1 similar comment
|
PR author is not in the allowed authors list. |
1 participant
Summary
This documents the registry-first workflow now that bootstrap generation, health generation, and freshness enforcement are split into smaller fork-side PRs.
Root cause
The original rollout notes still assumed a child-issue chain and did not reflect the actual fork process the repo should follow: one detailed tracking issue with several narrow PRs.
Changes
docs/architecture/dataset-registry.md#5Validation
npm run registry:checkRisk
Low. Documentation only.
Refs #5
Depends on #12