Skip to content

docs: replace RFCs with Architecture Decision Records#164

Merged
coji merged 1 commit into
mainfrom
docs/replace-rfcs-with-adrs
Mar 28, 2026
Merged

docs: replace RFCs with Architecture Decision Records#164
coji merged 1 commit into
mainfrom
docs/replace-rfcs-with-adrs

Conversation

@coji
Copy link
Copy Markdown
Owner

@coji coji commented Mar 28, 2026

Summary

  • Remove old RFC documents (docs/rfcs/) — content preserved in git history
  • Add docs/adr/ with ADR format and index
  • Add ADR-0001: Lease-based runtime model (captures Phase 1 decisions from Phase 1: Lease-based runtime model #101)
  • Add ADR guidelines to CLAUDE.md

Motivation

The RFCs were written before Phase 1 implementation and are now outdated. Rather than updating them, we switch to lightweight ADRs that capture decisions as they happen — written as proposed when work starts, updated to accepted when merged.

Test plan

  • No code changes — docs only
  • Verify git log -- docs/rfcs/ still shows old RFC history

🤖 Generated with Claude Code

Summary by CodeRabbit

リリースノート

  • Documentation
    • Architecture Decision Records(ADRs)体系を新たに導入し、アーキテクチャ決定の記録と管理プロセスを確立
    • リース型ランタイムモデルに関する初期ADRドキュメントを追加し、ランタイム設計の基本方針を文書化
    • ドキュメント構成を再編成し、従来のRFC設計ドキュメントを削除してADR体系に統一

Old RFC documents (runtime-rearchitecture, coalesce-trigger) are removed —
their content is preserved in git history. ADR-0001 captures the key
decisions from the Phase 1 lease-based runtime implementation.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 28, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Actions Updated (UTC)
durably-demo Ignored Ignored Mar 28, 2026 1:58am
durably-demo-vercel-turso Ignored Ignored Mar 28, 2026 1:58am

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 28, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Architecture Decision Records(ADR)ドキュメント体系を導入し、従来のRFC形式からの移行を実施しました。リース型ランタイムモデルに関する新規ADRを追加し、古いランタイム再設計RFC、データベース関連RFC、日本語翻訳を削除しました。

Changes

Cohort / File(s) Summary
ADR インフラストラクチャ & ドキュメント
CLAUDE.md, docs/adr/README.md, docs/adr/0001-lease-based-runtime.md
ADR体系の導入ルールを定義。ADR作成・遷移(proposed → accepted)のワークフロー、標準フォーマット(Status/Context/Decision/Consequences)、及びリース型ランタイムモデル(processOne()、leaseGeneration、Store統一インターフェース、atomic persistStep)の初期ADRを追加
ドキュメント構造の再編
docs/README.md
"Start Here" セクションおよびRFC直接リンクを削除し、ADR索引へのリンクに置き換え。先行設計ドキュメントは git history 経由での参照に変更
ランタイム再設計RFC削除
docs/rfcs/runtime-rearchitecture/*
README.mdcore-runtime.mddeployment-models.mddatabase-*.md など11ファイルを削除(英語)
ランタイム再設計RFC日本語翻訳削除
docs/rfcs/runtime-rearchitecture/ja/*
同等の日本語RFC文書7ファイル(README.md、core-runtime.md、deployment-models-ja.md等)を削除
その他RFC削除
docs/rfcs/coalesce-trigger/README.md, docs/rfcs/runtime-rearchitecture/phase1-exploration-notes.md
coalesce-trigger RFC及びPhase 1探索ノートを削除

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

ウサギの足で軽く跳ねて 🐰
古いRFCを整理して
新しいADRの道へ
リース型ランタイム、しっかり記録 ✨
アーキテクチャ、次の章へ

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title clearly and concisely summarizes the main change: replacing legacy RFC documents with a new Architecture Decision Records (ADRs) system. The title accurately reflects the primary objective of this changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/replace-rfcs-with-adrs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coji coji merged commit 09a5b61 into main Mar 28, 2026
5 checks passed
@coji coji deleted the docs/replace-rfcs-with-adrs branch March 28, 2026 02:00
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