docs: add product surface map and minimal winning slice assumptions#23631
docs: add product surface map and minimal winning slice assumptions#23631BrianCLong wants to merge 1 commit intomainfrom
Conversation
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 19 minutes and 19 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✨ 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 |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a260aa2915
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
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".
| - Evidence ID pattern: `EVID:<surface>:<entity-or-job>:<seq>` | ||
| - Example: `EVID:ask.answer:company-123:0007` |
There was a problem hiding this comment.
Use existing evidence ID contract for v1 surface docs
The proposed contract switches to EVID:<...> IDs, but current repository schemas and verification gates still validate EVD-... IDs (for example docs/api/evidence.report.schema.json and docs/api/evidence.stamp.schema.json both require ^EVD-). Because this file defines the MWS contract, implementers following it will generate IDs that fail existing validation and CI checks, so the doc should either align with the enforced format or explicitly document a coordinated validator migration.
Useful? React with 👍 / 👎.
| - Deterministic files must not include unstable timestamps: | ||
| - `report.json` | ||
| - `metrics.json` | ||
| - `stamp.json` |
There was a problem hiding this comment.
Exclude stamp.json from the no-timestamp deterministic set
This guidance forbids unstable timestamps in stamp.json, but the current stamp contract requires a timestamp field (createdAtIso in docs/api/evidence.stamp.schema.json) and repository guidance states timestamps are permitted in stamp artifacts. Keeping stamp.json in the blanket ban creates a direct contract conflict that will mislead follow-on implementation work into either violating schema or dropping required metadata.
Useful? React with 👍 / 👎.
a260aa2 to
c305be9
Compare
Motivation
Description
docs/api/product-surfaces.mdwhich defines surface families, the five-surface MWS, acceptance tests, the proposedEVID:<surface>:<entity-or-job>:<seq>evidence ID pattern, and a rollout sequence for v1.docs/architecture/product-surface-map.mdwhich maps each proposed surface to concrete repo paths, documents the MWS architecture flow, and lists rollout guardrails and DoD scoring criteria.repo_assumptions.mdto record verified vs assumed paths, unknown contracts needing owner confirmation, must-not-touch files, validation commands, and owner groups for follow-on implementation work.report.json,metrics.json,stamp.json), and conservative, additive rollouts.Testing
pnpm exec prettier --checkon the new/updated files and the check passed.pnpm exec prettier --writeto apply formatting todocs/api/product-surfaces.md,docs/architecture/product-surface-map.md, andrepo_assumptions.md, and the write completed successfully.Codex Task