ドキュメントの更新規則
正本とバージョン
この dicks-lang/docs が公式ドキュメントの正本です。言語・SDKの実装はそれぞれのリポジトリで管理します。言語リポに残る文書は配布用スナップショットであり、両方を手で編集しません。
Docusaurusのバージョン管理で、開発中の仕様と固定した仕様を分けます。snapshotは文書の基準点で、正式なパッケージ公開を意味しません。未確認の過去リリースや日付は作りません。
更新時に必要なもの
- 追加・変更・修正・削除した内容と対象コンポーネント。
- 対応する言語のバージョン、パッケージのバージョン、ソースの完全なコミットSHA。
- 互換性への影響と移行手順。変更不要ならその根拠。
- 実行できる最小例と期待出力、検証結果、既知の制約。
運用
npm ci --ignore-scripts、npm run check で文書・リンク・バージョン情報・ビルドを検査します。公開するバージョンは releases/<version>.json とリリースノートを作成し、npm run snapshot -- <version> で固定します。リリース番号や同じバージョンの内容を再利用しません。公開済みの文書に誤記があれば、そのバージョンの訂正として修正します。
GitHub Releaseやレジストリ公開は別の操作です。このコマンドは公開・secret登録・本番配備をしません。配布したコンパイラやパッケージのバージョンが変わる場合は、対応する実装リポのCIと変更内容も確認します。