Skip to content

Triage seed knowledge and document admission test for preview#5

Merged
JesperSchulz merged 2 commits into
mainfrom
triage/preview-sanity-check
Apr 23, 2026
Merged

Triage seed knowledge and document admission test for preview#5
JesperSchulz merged 2 commits into
mainfrom
triage/preview-sanity-check

Conversation

@JesperSchulz
Copy link
Copy Markdown
Collaborator

Summary

Preparing the repo for the community preview announcement next week. Two changes:

Delete seven knowledge files that fail the remedial-knowledge premise. BCQuality exists to capture things a capable LLM would get wrong or miss without it. These seven seed articles encode generic software-engineering guidance that modern LLMs already apply without BCQuality present:

  • performance/use-strsubstno-for-message-formatting — "don't concatenate, use a format function"
  • performance/keep-transaction-scope-short — generic transactional advice; the BC-specific nuance lives in the sibling articles (avoid-commit-inside-loops, avoid-user-interaction-in-transactions)
  • security/avoid-sensitive-data-in-error-messages — OWASP generics
  • security/do-not-put-credentials-in-urls — OWASP generics
  • security/do-not-swallow-security-errors-silently — "log your errors"
  • security/require-https-for-external-calls — "use HTTPS"
  • security/set-timeouts-for-external-calls — "set a timeout"

Verified no inbound references from other knowledge files before deletion.

Strip the "Seed article — domain stewards should expand" banner from ten showcase-grade files whose content is ready for a preview audience: AA0232/AA0233 rules, FindSet read-only semantics, SetLoadFields ordering and usage, CalcFields-in-loops, SecretText end-to-end, DataClassification. The banner remains on the other seed articles that still need steward refinement.

Add a "What belongs here" section to the README stating the admission test explicitly:

If this file did not exist, would a modern LLM reviewing or generating BC code make a mistake this file would have prevented?

Gives contributors a concrete yes/no filter before they open a PR, and frames the preview corpus as intentionally narrow rather than incomplete.

Test plan

  • README renders cleanly on GitHub and the new section reads well
  • CI validation still passes (schema + line-count checks) on all remaining knowledge files
  • No links in agent-consumption.md or skills/*.md point to the deleted files
  • Domain stewards sanity-check the keep/delete split before the preview announcement

Remove seven knowledge files whose content is generic software-engineering
guidance that a capable LLM already applies without BCQuality present
(HTTPS-only, secret-leakage-in-errors, no-credentials-in-URLs, silent
security-error swallowing, short transaction scope, HTTP timeouts,
StrSubstNo-vs-concatenation). These fail the remedial-knowledge premise
and dilute the signal of the preview corpus.

Strip the "Seed article — domain stewards should expand" banner from ten
files that are ready to showcase (AA0232/AA0233 rules, FindSet read-only
semantics, SetLoadFields ordering and usage, CalcFields-in-loops,
SecretText end-to-end, DataClassification). The banner remains on files
that still need domain-steward refinement.

Add a "What belongs here" section to the README stating the admission
test: a file exists only if a modern LLM would get something wrong or
miss something without it. Gives contributors a concrete yes/no filter
before they open a PR.
Most of the corpus — FindSet/SetLoadFields/CalcFields patterns, permission
sets, SingleInstance codeunits, DataClassification, IsolatedStorage,
transaction scope, SecretText — describes BC platform behaviour that is
identical across supported versions. The seed [26..28] range on every
file implied a version-specificity the content does not actually have,
and there was no way to express "applies to every version" in the
schema the way [w1] and [all] already do for countries and
application-area.

Extend the v1 schema with a universal sentinel for bc-version, parallel
to the sentinels already defined for the other dimensions:

  bc-version: [all]         # applies to every BC version

[all] is mutually exclusive with explicit versions. Range shorthand
([26..28]) and explicit lists ([26, 27, 28]) continue to work for files
genuinely tied to a version-gated API or deprecation.

Update read.md (field definition, matching semantics, partial-context
rule), write.md (default to [all], use ranges only with a concrete
reason), README.md (frontmatter example), and the CI validator. All
forty existing knowledge files and the three action skills convert to
[all]; none of the current content is version-gated. Validator passes.
@JesperSchulz JesperSchulz merged commit c00db1e into main Apr 23, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant