Skip to content

README.md

Latest commit

 

History

History
131 lines (107 loc) · 8.13 KB

README.md

File metadata and controls

131 lines (107 loc) · 8.13 KB
Raw

DataLogicEngine documentation portal

Generated by scripts/generate_documentation_portal.py from config/documentation-authority.json and the current CP16-F closure report. Do not hand-edit.

Authority and release status

  • Generated: 2026-08-20
  • Documentation authority: 2026.08.10-cp19l-installed-evidence (approved_phase16_replacement_closed)
  • Canonical hand-maintained documents: 30 of 30
  • CP16-F replacement status: pass
  • Routed sources: 72; archived: 72; unmigrated links: 0
  • Current program checkpoint: Phase 19 CU-2; exact-source 4.4.2 integrity, payload, governance, and package-owned portable readiness pass while fresh-installed/provider/signing CP19-M acceptance remains open
  • Current evidence: all 213/213 KAs are individually qualified and the 186-row baseline backlog is closed through 36 dependency-safe groups. The current local engineering build recorded against source base 103f52e5f9b51f937ac2da8adc17523ec98affdb is DataLogicEngine Setup 4.4.2.exe (358849388 bytes; SHA-256 ece59ad3e1e36afabd9856b29839254c626638cbcb2d4f00d7efe51c24031f8a); it is unsigned, its integrity/checksum/block-map gate passes, and portable smoke reached package-owned backend readiness in 38848 ms. The build report records the exact source commit; signed installed release binding remains open. It has not passed installed-mode acceptance and does not replace the distinct 2026-08-10 installed qualification artifact recorded in the release and V&V records. One-time installed retained-data adoption preserved 22,068 listed relational rows, 20 graph nodes/18 relationships, and eight objects. The reviewed dataset exporter remains supporting owner tooling and does not satisfy installed training/provider acceptance. CP19-M remains open for the signed exact artifact and every retained installed/manual/external/provider/pilot/soak gate.
  • Production/public release: NO-GO until the installed, accessibility, security, signing, external-review, and release gates in root TODO.md pass.

The authoritative program is root PRODUCTION_COMPLETION_PLAN_2026.md; root TODO.md is its execution ledger and root HANDOFF.md is the current checkpoint. Historical documents under docs/archive/ retain evidence and context but are not current product or operating authority.

Start here by role

Role Read first
User or evaluator README.md, docs/PRODUCT_REQUIREMENTS.md, docs/INSTALLATION_GUIDE.md, docs/USER_GUIDE.md
Owner or operator docs/ADMINISTRATOR_OPERATIONS_GUIDE.md, docs/TROUBLESHOOTING_SUPPORT_GUIDE.md, docs/MAINTENANCE_DISASTER_RECOVERY.md
Engineer or architect docs/DEVELOPER_GUIDE.md, docs/ARCHITECTURE.md, docs/DATA_ARCHITECTURE.md, docs/INTERFACE_INTEGRATION.md
Security, privacy, or AI reviewer SECURITY.md, docs/SECURITY_ARCHITECTURE.md, docs/PRIVACY_IMPACT_ASSESSMENT.md, docs/evaluation/AI_SYSTEM_CARD.md
Accessibility reviewer docs/ACCESSIBILITY_CONFORMANCE_REPORT.md, docs/USER_GUIDE.md
Release or external reviewer docs/REQUIREMENTS_TRACEABILITY.md, docs/VERIFICATION_VALIDATION_REPORT.md, docs/RELEASE_READINESS_RECORD.md, docs/PROFESSIONAL_REVIEW_INDEX.md

Canonical document set

Product and public

ID Document Authority
DLE-ROOT-001 README.md Product entry point
DLE-ROOT-002 CHANGELOG.md Product change log
DLE-ROOT-003 SECURITY.md Vulnerability reporting and disclosure policy
DLE-PROD-001 docs/PRODUCT_REQUIREMENTS.md Product requirements and acceptance specification
DLE-USER-005 docs/PRIVACY_AI_NOTICE.md Privacy, provider, retention, and AI limitations notice

User, administrator, and support

ID Document Authority
DLE-USER-001 docs/USER_GUIDE.md User guide
DLE-USER-002 docs/INSTALLATION_GUIDE.md Installation and lifecycle guide
DLE-USER-003 docs/ADMINISTRATOR_OPERATIONS_GUIDE.md Administrator and operations guide
DLE-USER-004 docs/TROUBLESHOOTING_SUPPORT_GUIDE.md Troubleshooting and support guide

Engineering and maintenance

ID Document Authority
DLE-ROOT-004 CONTRIBUTING.md Contribution controls
DLE-ROOT-005 TODO.md Open production work and release blockers
DLE-ROOT-006 HANDOFF.md Current checkpoint and next action
DLE-ENG-001 docs/ARCHITECTURE.md System architecture description
DLE-ENG-002 docs/DATA_ARCHITECTURE.md Data architecture and schema specification
DLE-ENG-003 docs/INTERFACE_INTEGRATION.md Interface and client-integration specification
DLE-ENG-004 docs/SECURITY_ARCHITECTURE.md Security architecture and threat model
DLE-ENG-005 docs/SOFTWARE_LIFECYCLE_PLAN.md Software lifecycle and configuration-management plan
DLE-ENG-006 docs/DEVELOPER_GUIDE.md Developer build, test, packaging, and reproducibility guide
DLE-ENG-007 docs/MAINTENANCE_DISASTER_RECOVERY.md Maintenance and disaster-recovery plan

Assurance, release, and external review

ID Document Authority
DLE-ASR-001 docs/REQUIREMENTS_TRACEABILITY.md Requirements traceability matrix
DLE-ASR-002 docs/VERIFICATION_VALIDATION_REPORT.md Verification and validation plan and report
DLE-ASR-003 docs/evaluation/AI_SYSTEM_CARD.md AI system card and evaluation report
DLE-ASR-004 docs/KA_TRUTHCORE_VALIDATION_DOSSIER.md KA and TruthCore validation dossier
DLE-ASR-005 docs/PRIVACY_IMPACT_ASSESSMENT.md Privacy impact assessment and data inventory
DLE-ASR-006 docs/ACCESSIBILITY_CONFORMANCE_REPORT.md Accessibility conformance report
DLE-ASR-007 docs/THIRD_PARTY_SOFTWARE_INDEX.md SBOM, licensing, redistribution, and notices index
DLE-ASR-008 docs/RELEASE_READINESS_RECORD.md Release readiness and go-no-go record
DLE-EXT-001 docs/PROFESSIONAL_REVIEW_INDEX.md Professional review index
DLE-EXT-002 docs/MICROSOFT_SUBMISSION_DOSSIER.md Microsoft distribution and submission dossier
DLE-EXT-003 docs/INDEPENDENT_REVIEW_RECORD.md Independent review record

Supporting review inputs

These current findings and work queues inform remediation but do not supersede the root production plan, TODO, or handoff:

  • CODEX_WORK_QUEUE_2026-08-10.md
  • docs/AUTH_SURFACE_MATRIX.md
  • docs/CI_QUALITY_POLICY.md
  • docs/DATASET_EXPORT_HANDOFF.md
  • docs/DESKTOP_CSP.md
  • docs/DMRF_TRUTH_BOUNDARY.md
  • docs/MEMORY_AUTHORITY.md
  • docs/audits/DataLogicEngine_Consolidated_Update_Plan_2026-08-18.md
  • docs/audits/CURRENT_BUILD_DOCUMENTATION_RECONCILIATION_2026-08-11.md
  • docs/audits/UKG_Spec_vs_App_Findings_2026-08-10.md
  • docs/spec-exports/ka_registry_213.yaml
  • docs/spec-exports/17_axis_coordinate_schema_axes14-17.yaml
  • docs/spec-exports/api_delta.md

Generated companions and machine-readable contracts

  • docs/DOCUMENTATION_BOM.md - controlled canonical bill of materials.
  • docs/DOCUMENTATION_CROSSWALK.md - complete file disposition inventory.
  • docs/GENERATED_STRUCTURE.md and docs/FILE_INVENTORY.csv - repository inventory.
  • docs/openapi.yaml - API schema where applicable.
  • docs/generated/PRODUCTION_CONTRACT_INDEX.md - generated product, provider, service, route, environment, and installer parity view.
  • docs/adr/README.md - historical ADR index; current decisions are consolidated into canonical architecture documents.
  • reports/production-readiness/2026/ - phase and release evidence.

Historical and retained evidence

The CP16-F baseline records SHA-256 and Git blob identity for every routed source before archival. The closure report records its canonical target, archive location, retained hash, technical review, and link-migration result. Archived material must be checked against current code and canonical documents before reuse.

Validation

python scripts/generate_documentation_authority.py
python scripts/verify_documentation_bom.py
python scripts/verify_doc_authority.py
python scripts/verify_document_replacement_closure.py
python scripts/verify_docs_references.py
python scripts/verify_requirements_traceability.py