Skip to content

📝 実装と食い違っていたドキュメントを直す - #45

Merged
yasulab merged 1 commit into
mainfrom
fix-stale-docs
Aug 31, 2026
Merged

yasulab merged 1 commit into
mainfrom
fix-stale-docs

Conversation

@yasulab

@yasulab yasulab commented Aug 31, 2026

Copy link
Copy Markdown
Member

#42 をマージしたあと通しで見直したところ、実装に無いものを案内している記述が見つかりました。

存在しない cache_dojo_logos の案内(6 箇所)

ロゴの取り込みは #44 でやめ、coderdojo.jp から直接読み込む方式にしました。その際 CLAUDE.mdREADME.md を直しておらず、実行するとエラーになるコマンドを案内したままでした。

bundle exec rake cache_dojo_logos    # このタスクは存在しない

_tasks/cache_dojo_logos.rb も Rakefile のタスクもありません。ビルドフックが実行するのは upsert_dojos_geojsoncompact_geojson の 2 つだけです。images/dojos/*.webp も同じ理由で残骸になっていました。

実在しないスクリプト名(3 箇所)

記述 実際
get_dojos_from_earth.rb get_data_from_earth.rb
get_dojos_from_japan.rb get_data_from_japan.rb
get_events_from_japan.rb 存在しない(イベントは get_data_from_japan.rb が Dojo と一緒に取得する)

Slack 通知の対象が、スクリプトとワークフローで食い違っていた

_tasks/upsert_dojos_geojson.rb のコメントは「uuid_not_in_clubs だけが要対応」のままでしたが、#42no_uuid も通知対象にしています。

no_uuid は coderdojo.jp 側の spec が防いでいるはずの状態なので、出たら上流の保証が破れています。club_excluded_by_status_or_coordinates を通知しない理由も併記しました。

ステータスの説明が不正確だった

-| `club_excluded_by_status_or_coordinates` | クラブはあるが、座標が無いか活動中ではない |
+| `club_excluded_by_status_or_coordinates` | クラブはあるが、座標が無いか、準備中・活動中のどちらでもない |

PLANNING(準備中)も地図に出すため、「活動中ではない」は不正確です。coderdojo.jp 側の手順書は直していましたが、こちらを直し忘れていました

検証

  • bundle exec rake test → minitest 14 + 7 runs / 0 failures、HTML-Proofer 成功
  • cache_dojo_logos / get_dojos_from / get_events_from が残っていないことを grep で確認

見直しで、実装に無いものを案内している記述が見つかった。

## 存在しない cache_dojo_logos の案内 (6 箇所)

ロゴの取り込みは #44 でやめ、coderdojo.jp から直接読み込む方式にした。
その際 CLAUDE.md と README を直しておらず、実行するとエラーになる
コマンドを案内したままだった。

    bundle exec rake cache_dojo_logos    # このタスクは存在しない

`_tasks/cache_dojo_logos.rb` も Rakefile のタスクも無い。ビルドフックが
実行するのは upsert_dojos_geojson と compact_geojson の 2 つだけ。
`images/dojos/*.webp` も同じ理由で残骸になっていた。

## 実在しないスクリプト名 (3 箇所)

    get_dojos_from_earth.rb  -> get_data_from_earth.rb
    get_dojos_from_japan.rb  -> get_data_from_japan.rb
    get_events_from_japan.rb -> 存在しない (イベントは get_data_from_japan.rb が取得する)

## Slack 通知の対象が、スクリプトとワークフローで食い違っていた

upsert_dojos_geojson.rb のコメントは「uuid_not_in_clubs だけが要対応」の
ままだったが、#42 で no_uuid も通知対象にしている。no_uuid は coderdojo.jp
側の spec が防いでいるはずの状態で、出たら上流の保証が破れている。
club_excluded_by_status_or_coordinates を通知しない理由も併記した。

## ステータスの説明が不正確だった

「座標が無いか活動中ではない」と書いていたが、PLANNING (準備中) も地図に
出すため「準備中・活動中のどちらでもない」が正しい。coderdojo.jp 側の
手順書は直していたが、こちらを直し忘れていた。
@yasulab
yasulab merged commit cfa1478 into main Aug 31, 2026
3 checks passed
@yasulab
yasulab deleted the fix-stale-docs branch August 31, 2026 09:03
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