docs: make README product-first and integrator-friendly - #160
docs: make README product-first and integrator-friendly#160seonghobae wants to merge 13 commits into
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughREADME가 증거 중심 HRIS/HCM 제품 범위, bounded context, 아키텍처 경계, 검증 절차, PII 보호 계약, 현재 상태, 문서 맵, 기여 지침 및 라이선스를 설명하도록 확장되었습니다. ChangesREADME 제품 및 저장소 기준
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to This PR updates documentation and its integrity record without changing runtime, dependency, schema, API, workflow, release, permission, or product behavior; no actionable merge-blocking risk remains beyond normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) ✨ 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 |
Outcome
Refresh Orgmetra's protected-
developlanding page around its code-current HRIS/HCM responsibility instead of mixing the product story with stale active-PR state.npm ci,npm run validate);Evidence and licensing
The README is grounded in
docs/PRD.md,ARCHITECTURE.md,docs/TRACEABILITY.md, package metadata, repository workflows, and the existing rootLICENSE/NOTICE. The Apache-2.0 grant applies to Orgmetra-owned source; third-party packages and external systems retain their own terms. No certification, production deployment, employment-decision authority, or customer claim is invented.Repair chain
Fresh hosted validation first proved that the README manifest record was stale; the branch resealed it from the exact README bytes instead of weakening repository integrity. Fresh review then found an unsealed
docs/index.mdpublic landing candidate outside the validator's closed required-artifact set. That candidate was removed rather than widening the public surface without a publication/integrity contract, leaving the governed root README as the landing source.Current README maturity labels distinguish protected-main implementation, accepted architecture, and planned/active-PR boundaries, including separate Psychometrics Commons versus fast-mlsirm responsibilities. Validation scope is explicit so
npm run validateis not represented as complete PostgreSQL/package verification.The README also separates Orgmetra-local controls/trust-boundary documentation from vulnerability disclosure. Suspected vulnerabilities are directed to the organization-owned
ContextualWisdomLab/.github@main:SECURITY.mdreporting policy. No claim is made that repository-private vulnerability reporting is enabled unless live repository evidence establishes it.The current manifest seal matches the exact README bytes after that reporting repair (
sha256=10f4ad947efee5e54166cd31e18cf30d34489b7c13fd05cb565363c1a86271c5, 9,344 bytes, 141 lines). All currently returned inline review threads are resolved.Exact-head authority — 2026-09-02
develop@9e3e4847510e1e612b48474ba42b177b8ed824df;a7d9e1aa0fb6e007e3b0cb8f495f4d4dc512e9e8;33586731896, Recovery Rehearsal Quality33586731888, and Job-Analysis API Quality33586731749are terminal-success;33586731818is terminal-failure only atdependency-reviewjob100112343570: exact checkout succeeded, the support probe failed, and the pinned Dependency Review action was skipped; sibling Trivy, OSV, and Scorecard jobs are terminal-success;33586731773remains queued and therefore non-passing;ContextualWisdomLab/.github#810, not an Orgmetra README/runtime defect;Scope
Current diff is exactly
README.mdandmanifest.json. No runtime, dependency, schema, API, workflow, release, certification, employment-decision, UI, or ecosystem-ownership behavior is changed.Merge boundary
Do not merge or enable auto-merge until this unchanged exact head has terminal applicable repository/security/recovery checks, current review/thread evidence, fresh base ancestry/mergeability, and then-live protected-branch rules. No self-approval, routine administrator bypass, force-push, no-op retrigger churn, or predecessor-evidence transfer is requested.