Skip to content

develop → main: ドキュメント UX 改善・API 不整合修正#25

Merged
higuuu merged 23 commits into
mainfrom
develop
Mar 23, 2026
Merged

develop → main: ドキュメント UX 改善・API 不整合修正#25
higuuu merged 23 commits into
mainfrom
develop

Conversation

@higuuu
Copy link
Copy Markdown
Contributor

@higuuu higuuu commented Mar 23, 2026

Summary

  • API Reference 生成スクリプトの改善(LLM 3-pass パイプライン導入、ソースハッシュ方式の差分チェック)
  • パラメータテーブルの型情報自動補完・Required/Optional カラム追加
  • 例外セクションを HTTP ステータスコードマッピングテーブルに刷新
  • README にロゴ・アーキテクチャ図・クライアント構成表を追加
  • docstring の日本語統一、型情報修正(timeout: float)、ValidationError ステータスコード修正(400, 422)
  • evaluate() メソッドに内部メトリック名マッピングを追記
  • ブランド名 GenFlux → Genflux 統一

Included PRs

Test plan

  • make docs-check パス確認済み
  • make llms-check パス確認済み
  • develop ブランチの CI 全て成功

🤖 Generated with Claude Code

higuuu and others added 23 commits March 12, 2026 10:34
- result.engine 参照を削除(内部エンジン名の露出防止)
- callback= → on_progress= パラメータ名修正
- job.progress → job.progress_count 修正
- Config CRUD を ConfigCreate モデル使用に統一
- Config の不要な =None ボイラープレート削除
- インデント修正、二重セパレータ削除
- README 改善(Anthropic/Stripe パターン準拠)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
fix: ドキュメント UX 改善・API 不整合修正
- パラメータテーブルに型情報を自動補完(signature から取得)
- Required/Optional カラムを追加
- 例外セクションを HTTP ステータスコードマッピングテーブルに刷新
- 例外ハンドリングのコード例を追加
- 概要セクションをコンパクトに再構成(ASCII図削除)
- メトリックテーブルに contexts/ground_truth 必須情報を追加
- 二重セパレータ修正

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add 3-pass LLM pipeline (enrich → hallucination check → UX review)
- Add Mermaid architecture diagram to overview section
- Add openai, python-dotenv to dev dependencies
- Add docs-enrich / docs-enrich-fresh Makefile targets
- Section-level processing to avoid API payload limits
- Cache enriched output for repeated runs

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Change brand name references from "GenFlux" to "Genflux" in all
documentation, scripts, and pyproject.toml. Code references
(`GenFlux` class, `GenFluxError`, imports) are unchanged.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- `--enrich` フラグを削除、`make docs` が常に品質重視の 3-pass パイプライン(改善→ハルシネーションチェック→UXレビュー)を実行するように変更
- `make docs-enrich` / `make docs-enrich-fresh` を `make docs` / `make docs-fresh` に統合
- Pass 2/3 のフェンス除去を `_clean_llm_output()` に統一
- 未使用の `import json` を削除

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Markdown テーブルセル内の `|` がセル区切りとして解釈され、
`str	None` のように表示される問題を修正。
テーブル出力時に `|` を `\|` にエスケープする関数を追加。

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- README に Why Genflux セクション追加(ハルシネーションチェック済み: セキュリティテスト/ポリシーチェックは Platform 機能と明記)
- API リファレンスに通し番号を追加(1. 概要、2. クライアント、2.1 GenFlux、2.1.1 evaluation() など)
- CONTRIBUTING.md, CHANGELOG.md のブランド名を GenFlux → Genflux に修正
- README のスコア表記を「高いほど良い」「低いほど良い」に変更

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Genflux ロゴ画像を assets/ にコピーし README 先頭に表示
- Why Genflux の後に Mermaid アーキテクチャ図とクライアント構成テーブルを追加

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
--check モードでは LLM enrichment をスキップし、見出し・シグネチャ・
テーブルなど構造部分のみで比較するように変更。ソースコード変更の
検出には十分で、CI に API キーを設定する必要がなくなる。

また README に「できること」セクションを追加。

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
LLM enrichment 済みドキュメントと素の生成結果は比較不可能なため、
API キーなしの CI ではファイル存在確認のみ行いパスするように変更。
API キーありの環境では従来通り完全な差分チェックを実行する。

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
LLM 出力は非決定的なため内容比較では CI が安定しない。
代わりに make docs 時にソースファイル群の SHA256 ハッシュを
<!-- source-hash: xxx --> としてドキュメントに埋め込み、
--check ではハッシュの一致のみを検証する。

これにより OPENAI_API_KEY の有無に関係なく、
「ソースを変えたのに make docs していない」を確実に検出できる。

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
GitHub のダークモードで黒文字の logotype が背景に溶けて見えなく
なっていた。<picture> タグで prefers-color-scheme を使い、
ダークモード時は logomark(青アイコン)を表示するよう切り替え。

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- <picture> タグで白版ロゴタイプ (logotype_w.png) をダークモード時に表示
- favicon.png (舵輪アイコン) をサブタイトル横に配置
- Enterprise frontend から素材をコピー

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2.2.2 delete(...) のような冗長な番号付けを廃止。
クラスレベル(2.1, 2.2)までは残し、メソッドはメソッド名のみで表示。
LLMプロンプトにも2階層ルールを明記。

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
3階層通し番号の削除 + LLM 3-pass パイプラインによる再生成。

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- GenFlux コンストラクタの timeout 型を float に修正(docstring に型注釈追加)
- ValidationError の HTTP ステータスコードを 400, 422 に修正
- evaluate() メソッドに内部メトリック名マッピングを追記
- 全メソッド・クラスの説明文を日本語に統一
- make docs で API Reference を再生成

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
_EXCEPTIONS_SECTION のハードコード定数が docstring 修正に追従していなかった問題を修正。

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
ハードコードされた例外ツリー図の ValidationError (422) を (400, 422) に修正。

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
fix: API Reference 生成スクリプト改善
@higuuu higuuu merged commit 1fc8173 into main Mar 23, 2026
2 checks passed
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