docs: make kaefa README product-first and license-aware - #81
Conversation
Add docs/adr/ for decisions already true on develop: mirt delegation, Zh / S-X2 / Rasch infit gates, AICc and DIC boundaries, and local default as an independent R package. Point ARCHITECTURE.md, README, and docs/papers/README.md at the new index. Co-authored-by: Seongho Bae <seonghobae@users.noreply.github.com>
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueThanks 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 |
Satisfy markdownlint MD034 without dropping the required DOI URLs. Co-authored-by: Seongho Bae <seonghobae@users.noreply.github.com>
|
Public-surface coordination: #82 now owns the existing |
|
Public-surface coordination update: this existing README writer now also carries the exact Ask DeepWiki badge in both |
|
Public-surface/security follow-up on exact head |
Outcome
Consolidate kaefa's current methodological ADR work with a product-first repository landing on the existing authoritative documentation branch, without changing R runtime behavior.
README.Rmdand generatedREADME.mdtogether;seonghobae/kaefainstall/CI links, Travis/AppVeyor status surfaces, changelog-style “New Feature” copy, and unsourced runtime/sizing estimates from the customer-facing landing;Product / scientific boundary
kaefa remains an R package for automated exploratory factor/IRT model search.
aefa()coordinates candidate search andengineAEFA()performs lower-level estimation; the current numerical estimation boundary ismirt. The package also contains the optional Shiny surfacelaunchAEFA()and remote-host initialization throughaefaInit().The README now preserves the explicit productization boundaries already documented in
ARCHITECTURE.md:kaefa-core,kaefa-studio, and a futurekaefa-runnerdeployment boundary. It does not promote the future runner into a separately released product or turn exploratory search into confirmatory/scientific-validity evidence.Source metadata is
0.1.428; the GitHub release inventory is currently empty. The README therefore does not treat a source version, historical badge, or passing development check as immutable release/support evidence.Commercial licensing due diligence
Fresh repository/package inspection found a material policy blocker:
DESCRIPTIONdeclares kaefa itself asGPL-3;LICENSEfile;DESCRIPTIONdirectly importsmirt (>= 1.27), a GPL-family numerical runtime used by the product's estimation/search paths;ths,ctb), so repository ownership alone is not sufficient evidence for unilateral first-party relicensing without contribution/provenance review.Issue #83 now owns the complete first-party provenance/relicensing and GPL-family runtime/build replacement problem. Closure requires preserving the intentionally supported scientific estimands/search/recovery behavior with exact regression/recovery evidence rather than merely changing
DESCRIPTION, hiding dependency-license evidence, or moving the same GPL implementation behind another process boundary.Until #83 is resolved, kaefa is not currently cleared for ContextualWisdomLab commercial intake/distribution, and this documentation PR must not be presented as commercial-readiness evidence.
README truth repairs
The previous landing contained several stale or weak public surfaces that are removed from this branch:
seonghobae/kaefa;Source evaluation now points to ordinary package build/check commands and explicitly delegates exact environment/check authority to current package metadata and repository workflows.
Current exact authority — 2026-09-02
develop@5128d4867e24b5db73e6e3c8652a8dbeabd70aa0;a3f43ef4a61b96ba96271f3fbe81ebd5f79f51a3;R-CMD-check33582774270,test-fast33582774299,test-suite33582774286,SAST Semgrep33582774284, andSecurity Scan33582774258are all queued and therefore non-passing;Scope / merge boundary
Documentation only: README source/generated output plus the existing ADR/research/architecture documentation. No R source, package manifest, NAMESPACE, Shiny implementation, dependency graph, workflow, release, or repository setting is changed by this branch.
Keep Draft. Do not merge, mark Ready, tag, release, or use administrator bypass while #83 remains unresolved or any exact-head required gate is non-passing. Integration requires an unchanged head with current terminal repository/central checks, zero valid unresolved review findings, current ancestry/mergeability, and then-live protected governance.