From c4b03e27a5bf32e1eefe978c5fb0c445355e6643 Mon Sep 17 00:00:00 2001 From: Jesper Schulz-Wedde Date: Fri, 17 Apr 2026 13:47:01 +0200 Subject: [PATCH] Drop object-ID prescription from sample-file convention Sample code in knowledge articles is demonstration-only and never imported into a BC app, so object-ID uniqueness or ranges are not a property the READ contract needs to enforce. The Sample files section now just says samples are self-contained and demonstration-only, with no guidance about IDs. Existing samples keep whatever IDs they happen to have; future authors are free to use anything readable. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- skills/read.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skills/read.md b/skills/read.md index 96b39b9..b9a1562 100644 --- a/skills/read.md +++ b/skills/read.md @@ -130,7 +130,7 @@ Rules: - A sample file is identified by the article's slug followed by a `..` suffix. The supported kinds are `good` and `bad`. Additional kinds MAY be introduced by a layer; consumers MUST ignore unknown kinds without failing. - The extension matches the technology (`al`, `ps1`, `js`, `kql`, …). A single article MAY carry samples in multiple technologies if the article's frontmatter `technologies` lists them. - Articles MAY have a `good` sample only, a `bad` sample only, both, or neither. The article text SHOULD reference each sample it ships, using a relative path like `` `.good.al` ``. -- Samples are **demonstration-only**. They are not deployed, and they are not derived from the Business Central base application source. Authors use object IDs they own (e.g., 50100–50999 in Microsoft-authored samples) and keep each sample self-contained. +- Samples are **demonstration-only**. They are not deployed, not compiled as part of a published app, and not derived from the Business Central base application source. Each sample is self-contained and exists purely to make the accompanying article concrete for humans and agents. - Layer precedence applies to sample files the same way it applies to articles: a `/custom/knowledge//.good.al` overrides a `/microsoft/knowledge//.good.al` for the same article in the same layer hierarchy. Consumers that surface sample code to an end user or agent SHOULD cite the sample file by its repo-relative path, in the same format as article citations.