Skip to content

Polish README style and remove obsolete gitbook2md tool - #12

Merged
utahta merged 1 commit into
mainfrom
docs-cleanup
Jul 20, 2026
Merged

utahta merged 1 commit into
mainfrom
docs-cleanup

Conversation

@utahta

@utahta utahta commented Jul 20, 2026

Copy link
Copy Markdown
Owner

概要

READMEの文体・表記の統一と冒頭文の見直しを行い、役目を終えた gitbook2md ツールを削除する。

背景

  • READMEに表記ゆれ(V1/V2とv1/v2、「APIキー」と「API Key」、敬語レベル、文末の全角コロン)が混在していた
  • 冒頭の「日本の株式市場データに簡単にアクセスできます」は、APIキー登録や有料プランの前提が伝わらず誤解の余地があった
  • gitbook2md は公式ドキュメントがHTML配信のみだった時代にMarkdown変換のために作成したツールだが、現在は公式が .md を直接配信している(例: https://jpx-jquants.com/ja/spec/eq-bars-daily.md )ため不要になった

変更内容

READMEの文体・表記統一

  • v1/v2 の大文字小文字を本文表記に合わせて小文字に統一(見出し・移行表・コード例)
  • 「API Key」→「APIキー」、「ご確認ください」→「確認してください」に統一
  • 導入文末の全角コロン(〜ます:)を「。」に変更
  • 特徴セクションから自己評価的な項目(充実したテストカバレッジ・詳細なドキュメント)を削除
  • キャッシュのsingleflight挙動の説明を他の箇条書きと同じ粒度に短縮
  • 例の日付形式(20240208→2024-02-08)と銘柄コード桁数(13260→1326)を統一(公式仕様で両形式とも有効なことを確認済み)

冒頭文の見直し

  • 「簡単」の掛かり先をデータ取得ではなくライブラリの使い勝手に変更
  • APIキーが必要なこと、取得できるデータが契約プランに応じることを冒頭に明記

gitbook2md の削除

  • cmd/gitbook2md/ を削除(cmd/ 配下はこれのみのためディレクトリごと)
  • READMEのツールセクション・プロジェクト構造ツリー、.gitignore のエントリを削除
  • README / CLAUDE.md の公式ドキュメント参照先を旧GitBookから新URL(https://jpx-jquants.com/ja/spec/)に更新し、CLAUDE.md に .md 直接取得の補足を追加

テスト

  • make check パス(ドキュメントとツール削除のみで、ライブラリコードに変更なし)

- Unify notation (v1/v2 casing, APIキー, politeness level, sentence
  endings) and align example date/code formats in README
- Clarify the intro: "easy" now refers to the client library, and the
  API key / subscription plan requirement is stated upfront
- Remove cmd/gitbook2md since the official docs now serve Markdown
  directly (e.g. https://jpx-jquants.com/ja/spec/eq-bars-daily.md)
- Point doc references to the new official spec URL
@utahta
utahta merged commit 4da2723 into main Jul 20, 2026
4 checks passed
@utahta
utahta deleted the docs-cleanup branch July 20, 2026 02:18
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