Skip to content

docs: update CLAUDE.md with full doc sync checklist#163

Merged
coji merged 1 commit into
mainfrom
docs/claude-md-doc-sync
Mar 28, 2026
Merged

docs: update CLAUDE.md with full doc sync checklist#163
coji merged 1 commit into
mainfrom
docs/claude-md-doc-sync

Conversation

@coji
Copy link
Copy Markdown
Owner

@coji coji commented Mar 28, 2026

Summary

Update CLAUDE.md documentation section to list all files that need updating on API changes — both llms.md files, website API reference, and example apps. Previously only mentioned packages/durably/docs/llms.md.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • ドキュメンテーション
    • APIドキュメンテーション保守プロセスが改善されました。複数の関連ドキュメントを確実に同期するための包括的なチェックリストおよびドキュメント検証ワークフローが追加されました。

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 Preview Mar 28, 2026 1:45am
durably-demo-vercel-turso Ignored Ignored Preview Mar 28, 2026 1:45am

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 28, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 47266fe3-0a9f-4301-9a5d-1803bc17fadd

📥 Commits

Reviewing files that changed from the base of the PR and between 3b9b05d and 93b4ee4.

📒 Files selected for processing (1)
  • CLAUDE.md

📝 Walkthrough

ウォークスルー

CLAUDE.mdのLLMドキュメント保守ガイダンスを更新。単一ファイル(packages/durably/docs/llms.md)の指示から、複数のファイル(packages/durably/docs/llms.mdpackages/durably-react/docs/llms.mdwebsite/api/examples/)を同期させるチェックリストに拡大。API変更後の/doc-check実行を明示的に要求。また、生成アセットの再生成指示を改善し、llms.md編集時にllms.txtの再生成も追加。

変更箇所

コホート / ファイル サマリー
ドキュメント保守ガイダンス
CLAUDE.md
LLMドキュメント同期対象を単一ファイルから複数ファイルに拡大。API変更後の/doc-check実行要件を明示化。llms.txt再生成の条件を追加。

推定コードレビュー労力

🎯 1 (Trivial) | ⏱️ ~3分

関連する可能性のあるPR

  • feat: add LLM/AI agent documentation to npm package #8: packages/durably/docs/llms.mdの追加、npmパッケージへのドキュメント含有、website/public/llms.txtの追加に関連。本PRはこれらのファイルの同期ガイダンスを規定する直接的な関連性あり。

ポエム

ウサギぴょん、ドキュメント整理🐰
複数のファイルを仲良く保つ✨
llms.txtも生えてきた🌱
チェックリスト完成、パチパチ👏
同期の調和、美しい🌟

🚥 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 プルリクエストのタイトルは、CLAUDE.md ドキュメンテーションの更新という変更内容を正確に反映しており、ドキュメント同期チェックリストの追加という主要な変更を明確に示しています。
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/claude-md-doc-sync

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 95d4bb4 into main Mar 28, 2026
5 checks passed
@coji coji deleted the docs/claude-md-doc-sync branch March 28, 2026 01:48
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