Skip to content

docs: Record three closed decisions under docs/decisions - #76

Merged
semnil merged 3 commits into
masterfrom
docs/decision-records
Nov 11, 2026
Merged

semnil merged 3 commits into
masterfrom
docs/decision-records

Conversation

@semnil

@semnil semnil commented Nov 11, 2026

Copy link
Copy Markdown
Owner

Background

Some decisions made in #48, #49, #50, #63 and #68 were not written down in this repository: why prereleases are not in the release procedure, when the plugin drops a waiting track, and why the repository has no CLAUDE.md. This pull request records them under docs/decisions/, in English with a Japanese version beside each file.

Changes

  • docs/decisions/release.md and release.ja.md: prereleases are not part of the release procedure. The two rejected options, the conditions for revisiting the decision, and what the checks of CI: Tag a merged version bump and create the draft release on the tag #48 did not cover
  • docs/decisions/output-track-removal.md and output-track-removal.ja.md: waiting tracks are dropped on the frontend's scene collection events. The rejected option, and how linking obs-frontend-api changed with feat: Check GitHub for a newer release at startup #68
  • docs/decisions/documentation.md and documentation.ja.md: the repository has no CLAUDE.md, and the headings of the issue templates keep English and Japanese side by side

No existing file changes. docs/ is already listed in .gitignore, so .gitignore does not change.

Verification

At b6b9134:

  • Each English file and its Japanese version have their headings on the same lines (documentation: 1, 7; output-track-removal: 1, 8; release: 1, 8)
  • Relative links of the six files, resolved against the tree by a small script: 10 links, 0 broken
  • CMakeLists.txt line 5 is project(${_name} VERSION ${_version}), and bash .github/scripts/release-tag-shape 1.0.3-rc1 prints true and exits 0, as release.md says of the prerelease code that stays
  • CMakePresets.json line 13 sets "ENABLE_FRONTEND_API": true in the template preset, and src/plugin-main.c lines 990 to 992 hold the event numbers 13, 17 and 25, as output-track-removal.md says
  • 86e7a16 (cmake: Enable the frontend API and Qt in the presets) is a commit of feat: Check GitHub for a newer release at startup #68 (gh pr view 68 --json commits)
  • The timeline of docs: Make English the base language of the documents #50 has a head_ref_force_pushed event before its merged event (gh api repos/semnil/MixTrack2Source/issues/50/timeline), and origin/master has no CLAUDE.md

Not checked

  • The decision dates (2026-10-20 and 2026-10-25) and the reasons for the rejected options come from notes taken at the time. They cannot be derived from the tree

🤖 Generated with Claude Code

semnil and others added 3 commits November 11, 2026 20:23
Add docs/decisions/release.md and its Japanese version: the decision,
the two rejected options, the conditions for revisiting it, and what
the checks of #48 did not cover.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Add docs/decisions/output-track-removal.md and its Japanese version:
the decision to drop waiting tracks on the frontend's scene collection
events, the rejected option, and how linking obs-frontend-api changed
with #68.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Add docs/decisions/documentation.md and its Japanese version: the
repository has no CLAUDE.md, and the headings of the issue templates
keep English and Japanese side by side.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@semnil
semnil merged commit 222ec05 into master Nov 11, 2026
8 checks passed
@semnil
semnil deleted the docs/decision-records branch November 11, 2026 11:35
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