docs: documentatie-coverage voor accepted RFC's en engine-features#828
Draft
anneschuth wants to merge 1 commit into
Draft
docs: documentatie-coverage voor accepted RFC's en engine-features#828anneschuth wants to merge 1 commit into
anneschuth wants to merge 1 commit into
Conversation
Vult de grootste gaten tussen de accepted RFC's en de prose-documentatie, gegrond op gecommitte engine-testfixtures (trace-snapshots, BDD-features, conformance-manifests), niet op de externe corpus-repo. Nieuwe pagina's: - concepts/traceability: hoe je een trace leest, met de echte zorgtoeslag-trace (cross-law-keten, IoC-delegatie, gecachet resultaat, twee Awb-hooks) en hoe je er zelf een genereert (engine-trace). - concepts/competent-authority (RFC-002): bevoegd gezag op artikelniveau, INSTANCE/CATEGORY en de #-referentievorm. - concepts/temporal-and-dates (RFC-019 + RFC-021): versieselectie met valid_to en eerlijke afhandeling van verlopen referenties; datumvergelijking en DATE_DIFF. - concepts/notes-and-annotations (RFC-005 + RFC-018): stand-off notes, TextQuoteSelector, fuzzy matching en afgeleide autoriteit. - reference/conformance (RFC-014): de taal-agnostische conformance-suite en wat er vandaag wordt afgedwongen. - reference/documentation-coverage: per-RFC coveragematrix en de backlog van nog te schrijven onderwerpen. Verkort de Traceability-sectie in how-it-works tot een verwijzing en zet de nieuwe pagina's in de sidebar.
Preview Deployment — docs — docsYour changes have been deployed to a preview environment: URL: https://docs.pr828.rig.prd1.gn2.quattro.rijksapps.nl This deployment will be automatically cleaned up when the PR is closed. |
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
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.
Waarom
Een audit van alle RFC's tegenover de prose-documentatie liet zien dat de accepted RFC's en een aantal gebouwde engine-features dun of niet gedekt waren buiten de RFC's zelf. Aanleiding was traceability: dat concept had vijf regels in
how-it-worksen geen eigen pagina, terwijl de engine een rijk trace-mechanisme heeft met echte voorbeelden.Deze PR dicht de grootste gaten en zet de rest op een getrackte backlog. Draft- en proposed-RFC's blijven buiten scope; hun eigen pagina's zijn daarvoor de bron.
Wat
Vijf nieuwe concept-/referentiepagina's plus een coveragematrix:
concepts/traceabilityconcepts/competent-authorityname+type(INSTANCE/CATEGORY) en de#-referentievorm.concepts/temporal-and-datesvalid_toen eerlijke afhandeling van verlopen referenties; datumvergelijking enDATE_DIFF.concepts/notes-and-annotationsreference/conformancereference/documentation-coverageDaarnaast: de Traceability-sectie in
how-it-worksingekort tot een verwijzing, en de nieuwe pagina's in de sidebar gezet.Grondslag van de voorbeelden
Alle voorbeelden komen uit artefacten die in deze repo staan en via tests in sync blijven, niet uit de externe corpus-repo:
packages/engine/tests/expected_zorgtoeslag_trace.txt(gepind door een snapshot-test);features/einddatum.feature,features/date_operations.feature,features/notes.feature;conformance/;corpus/annotations/wet_op_de_zorgtoeslag/annotations.yaml.De geciteerde trace- en gherkin-fragmenten zijn karakter-voor-karakter tegen de bron geverifieerd.
Checks
npm run buildbouwt schoon (82 pagina's).check-links.mjs: geen kapotte interne links.check-heading-order.mjs: geen rang-sprongen.Backlog (apart, niet in deze PR)
reference/documentation-coveragelegt vast wat nog mist: de "waarom Rust" (RFC-006) en "waarom YAML" (RFC-011) rationale, en kleinere ongedocumenteerde features (traject-samenwerking, law-graph, WASM-API, data-sources, TUI, CLI-binaries, CVDR-harvesting, LLM-provider).