Skip to content

docs: 1.0 release notes, versioning strategy, README for adopters - #334

Merged
MendixMau merged 4 commits into
masterfrom
docs/release-1.0
Oct 14, 2026
Merged

MendixMau merged 4 commits into
masterfrom
docs/release-1.0

Conversation

@MendixMau

@MendixMau MendixMau commented Oct 14, 2026 •

Copy link
Copy Markdown
Owner

Direct lane

What changed and why (one paragraph):
The repo is going professional, so this adds three things. (1) docs/releases/v1.0.md is the first milestone's release notes, written for a Mendix developer or lead deciding whether to adopt. It covers the themes of 2026-09-30 to 2026-10-14, what each means for you, upgrading, known gaps and credits, and every claim links a CHANGELOG line or PR. (2) A versioning rule, added as docs/RELEASE-PROCESS.md §8 (the single source; the CHANGELOG header now defers to it). Milestones are named train releases; the vYYYY.MM.DD train and bin/cut-release.sh are unchanged, and tags start at 1.0. (3) A README rewrite for newcomers: what it is, how it works, ways to use it, quick start, Make it yours, testing and quality, We need your input, and releases. The old reference material is kept under "Reference", and both generated ROUTING blocks are untouched.

Field evidence: docs only, no instrument changed. Every path named in "Make it yours" was checked on master 31e90ae: templates/company-brain/, bin/init-company-brain.sh, bin/wire-company-brain.sh, init-project.sh --company, .claude/lint-rules-disabled.txt, bin/interview-mode.sh modes and persistence, bin/exec-approval.sh, bin/permission-profile.sh, the bin/wire-agents.sh tool list incl. --with-kiro, and sync touching only the marked blocks of CLAUDE.local.md.

  • No client data anywhere in the diff. The whole-word forbidden-name grep over added lines finds 0 hits, and LEAKGUARD_ALLOW_NO_DENYLIST=1 bin/check-no-client-data.sh is clean.
  • Size-cap exception (docs restructure). 4 files and about 672 counted lines (excluding CHANGELOG), mostly moved README text. It stays one PR, with the independent reviewer's agreement.
  • Test tier: T0, plus scoped fixtures tests/wave2/test-guide-reopen.sh bin/init-project.sh (10/10) and tests/wave2/test-routing-tier.sh bin/render-routing.sh (12/12). Also clean: render-routing.sh --check (baseline 74,995 before and after; README is not counted in the baseline), check-scripts.sh, check-no-private-citations.sh, check-pr-discipline.sh origin/master and check-docs-numbering.sh (no hits in the touched files).
  • CHANGELOG.md line under ## Unreleased, credited to MendixMau

Review

The independent review returned MERGE-AFTER-FIX. The fixes landed as a follow-up commit (f279645):

Decisions for the maintainer to confirm

  1. Version name "1.0". Proposal: the next bin/cut-release.sh cut becomes 1.0 and is the first tag pushed. The GitHub Release for that tag uses docs/releases/v1.0.md as its body, and a CHANGELOG pointer line is added in that cut's section.
  2. Milestone rule (§8). A major is anything that breaks a project without action and needs a Migration section plus a sync path. A change that sync migrates by itself counts as minor. Exit-code or output-format changes are named in the notes even when minor. Deprecations are removed no earlier than the next major.
  3. Removed from the README:
    • the "Decision flow" section (now a pointer to query-the-model.md);
    • "Stages 0–4: pure LLM" (duplicated the flow section);
    • "Stage 6: testing", including the stale screenshot-discipline paragraph;
    • the examples/ removal note;
    • the per-skill file tree (now directory level only);
    • "How to add a project-specific learning" (folded into "We need your input");
    • the long doctor --install explanation;
    • "Several other client integration and migration projects" under the renamed "Pipelines".
  4. Corrected in the README:
  5. Kept headings that other files cite by name: "Context cost", "Platform support", "When to use which skill", "Baseline routing", "Consuming this toolkit" and "How to add a new skill". Their heading levels went down one step under "Reference".
  6. Interview-mode values. The README documents the canonical values (steering/assist/auto, with "alias: unattended" next to auto). The script-side alias fix is a separate PR (fix/interview-mode-aliases).

🤖 Generated with Claude Code

https://claude.ai/code/session_01VJgWP5vEoAsNsJYqCDMGNw

- docs/releases/v1.0.md: first named milestone; themes of 2026-09-30..2026-10-14,
  what each means for adopters, upgrading, known gaps, credits. Every claim traces
  to a CHANGELOG line or PR.
- docs/RELEASE-PROCESS.md §8: single source for versioning. Milestones are named
  train releases (notes + GitHub Release + CHANGELOG pointer); major vs minor;
  cadence; deprecation; consumer check/upgrade/pin. Train tag format and
  cut-release.sh unchanged. CHANGELOG header defers to §8.
- README.md: restructured for newcomers (what it is, how it works, ways to use it,
  quick start, make it yours, testing, we need your input, releases); prior
  material kept under Reference with generated routing blocks untouched; stale
  pgrep hazard, hand-edit skill steps and stale Stage 6 / examples notes corrected.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VJgWP5vEoAsNsJYqCDMGNw
…dence pointer)

- v1.0.md: 1.0 is the first published train tag; note on PRs closed via #329;
  sync prints "none tagged yet" until tags exist; app-restart.sh is #304,
  #322 added the injection refusal; "UX001/002 plus Batches 1-4"; known gap
  for the stale-lock takeover race after a killed holder.
- RELEASE-PROCESS.md §8: tags start at 1.0; placeholders instead of a concrete
  tag; session ritual warns while pinned (expected); cadence defers to the
  CHANGELOG header instead of restating it.
- README.md: Toolkit release line before/after tags; tags start at 1.0;
  interview-mode --set persists in .claude/.interview-mode, env var is
  per-session; "alias: unattended" next to auto.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VJgWP5vEoAsNsJYqCDMGNw
Confirmation review of #334: bin/interview-mode.sh on master accepts only
steering|assist|auto, so "(alias: unattended)" was false. The alias lands
with fix/interview-mode-aliases, which can document it then.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VJgWP5vEoAsNsJYqCDMGNw
@MendixMau
MendixMau marked this pull request as ready for review October 14, 2026 03:36
@MendixMau
MendixMau merged commit 0e260c2 into master Oct 14, 2026
1 check passed
@MendixMau
MendixMau deleted the docs/release-1.0 branch October 15, 2026 10:45
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.

2 participants