Skip to content

refactor(rules): plain Markdown rule routing, draft fast-forward and missing project guide - #34

Merged
FLwolfy merged 7 commits into
mainfrom
draft
Nov 21, 2026
Merged

FLwolfy merged 7 commits into
mainfrom
draft

Conversation

@FLwolfy

@FLwolfy FLwolfy commented Nov 21, 2026 •

Copy link
Copy Markdown
Member

Problem

  • Documentation CI checked out the engine and verified this repository's rule text against line hashes in the engine's .agents/rulebook/coverage.json (scripts/check-rule-authority.ps1). The engine retires that registry, and a documentation rule edit needed a matching engine registry commit.
  • documentation.md carried rule-unit markers and anchors that existed only for that registry.
  • Guidance named one person as the commit author and as the source example, and linked a retired engine branch.

Final behavior

  • Rule files are plain Markdown that state their own paths and tags in front matter, in the format the engine rulebook defines. Engine tasks select them with the engine rule script and an explicit -DocsRoot; this repository remains their sole text authority.
  • scripts/check-rule-authority.ps1 and its workflow step are removed. Documentation CI no longer runs engine rule tooling.
  • scripts/check-guidance.mjs checks that every rule file has one-line paths or tags lists and stays within 16 KiB.
  • Delivery: a human vouches for every commit; no agent, bot or application identity may appear as author, committer, co-author or any other attribution. The protected API synchronization is the only automated committer.
  • The source examples use <author name>; engine links point to master.

Rule text is otherwise unchanged.

This pull request also carries the two automated API synchronization commits already on draft.

Verification

Run on Linux with Node 24.21.0 and PowerShell 7.5.4:

  • node scripts/check-guidance.mjs passed for 88 operational Markdown documents, and rejected a rule file without front matter.
  • npm test: 190 passed.
  • The engine rule script from the matching InnoEngine change selected these files with -DocsRoot by tag and by path.

Not run

  • The website build, browser tests and the Release validation of this pull request; Documentation CI runs them.

Related

InnoEngine replaces its rule registry with plain Markdown rule files in the matching pull request.

Added after opening

  • fix(docs): add the project guide for Inno.Build.ProductProfiles.Integration.Tests. The API synchronization registered the project without a guide, which failed complete release validation with "1 actual projects lack an authoritative entry".
  • feat(ci): add the Synchronize draft workflow. After each push to main it fast-forwards draft to main without creating a commit; it never forces and never touches another branch.
  • docs(rules): describe automatic project guide creation and removal (the tooling change is in refactor(rules): make agent rules plain Markdown with front-matter routing InnoEngine#89).

InnoEngine API synchronization and others added 6 commits November 20, 2026 10:16
…gine registry check

Rule files state their own paths and tags in front matter and lose the
rule-unit markers. Documentation CI no longer checks them against the
engine registry, which the engine retires; the guidance check validates
the front matter and the 16 KiB file limit instead.
A human vouches for every commit, and the protected API synchronization
is the only automated committer. The source examples use a neutral
author placeholder, and engine links point to master.
…the engine sync

The API synchronization registered Inno.Build.ProductProfiles.Integration.Tests in the project catalog, but no project guide owned it, so complete release validation failed with a missing authoritative entry. Add its guide and list it in the testing project index.
Add the Synchronize draft workflow. After a push to main it moves draft to main with an ordinary fast-forward push, so no commit is created and no force is used. When draft already contains main it does nothing; when draft has newer commits it leaves the merge to the next API synchronization. Document the behavior in the instructions, delivery rules and README, and cover the workflow boundary with a test.
@FLwolfy FLwolfy changed the title refactor(rules): declare rule routing in front matter and drop the engine registry check refactor(rules): plain Markdown rule routing, draft fast-forward and missing project guide Nov 21, 2026
Project guides follow the API page policy: synchronization registers a Synced guide for a new project that no project page owns and deletes the Synced guide of a removed project, while unregistered hand-authored pages stay untouched. The engine tooling change ships separately in the engine repository.
@FLwolfy
FLwolfy merged commit 695619c into main Nov 21, 2026
11 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