docs: full documentation refresh for the compliance-audit wedge - #41
Merged
Conversation
Rewrites README.md from scaffold boilerplate to reflect the shipped Wave-2 reality (Path A compliance-audit MVP). Rewrites docs/ARCHITECTURE.md to cover the 9 authoritative schemas, cross-schema aggregation pattern, ADR chain, and full ADR-031 PHP exception inventory with per-file justification. Adds docs/USER-GUIDE.md (Learner/Manager/Compliance-Officer walkthroughs), docs/ADMIN-GUIDE.md (install, register bootstrap workaround, signing keys, troubleshooting), docs/API.md (OR object API + 6 scholiq-specific endpoints with examples), and docs/SPECS.md (summaries of all 6 applied OpenSpec changes).
Contributor
Quality Report — ConductionNL/scholiq @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ❌ | ||||
| stylelint | ❌ | ||||
| composer | ✅ | ✅ 100/100 | |||
| npm | ❌ | ❌ | |||
| PHPUnit | ⏭️ | ||||
| Newman | ⏭️ | ||||
| Playwright | ⏭️ |
Quality workflow — 2026-05-12 05:26 UTC
Download the full PDF report from the workflow artifacts.
This was referenced May 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README.mdfrom scaffold boilerplate to reflect the shipped Wave-2 reality (Path A compliance-audit MVP): project description, quick-start with OR register import workaround (openregister#1487 / scholiq#35), link table to all docs, wedge description, tech stack.docs/ARCHITECTURE.md: 9 authoritative schemas with lifecycle/calculations/aggregations/notifications/relations; cross-schema aggregation pattern (Regulation coverage %); full ADR-031 PHP exception inventory (16 files, per-file justification); manifest page table (21 pages); honest note on planned-but-unshipped visibleIf / widget-ref (nc-vue#200).docs/USER-GUIDE.md: Learner / Manager / Compliance-Officer task walkthroughs.docs/ADMIN-GUIDE.md: install steps, register bootstrap workaround, signing key setup, per-Regulation RAG threshold config, public verify endpoint, troubleshooting (5 scenarios).docs/API.md: OR objects API patterns plus 6 scholiq-specific endpoints with request/response examples.docs/SPECS.md: 1-paragraph summary of all 6 applied OpenSpec changes with status.Test plan