Skip to content

docs: reorganize presentation method docs#40

Merged
abechan1 merged 1 commit into
mainfrom
codex/readme
Jul 1, 2026
Merged

docs: reorganize presentation method docs#40
abechan1 merged 1 commit into
mainfrom
codex/readme

Conversation

@abechan1

@abechan1 abechan1 commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Motivation

  • The README was becoming dense and hard to scan, so presentation-method details were split out to keep the project entrypoint concise and follow OSS documentation norms.

Description

  • Extracted the detailed "Presentation methods" section (architecture, YAML schema, plugin design, localization, and contribution workflow) into docs/presentation-methods.md.
  • Replaced the long section in README.md with a short --method usage example and added a Project resources section linking docs/presentation-methods.md, CHANGELOG.md, CODE_OF_CONDUCT.md, and LICENSE.
  • Adjusted README order to keep Roadmap and License visible while making the methods guidance discoverable from a dedicated doc.
  • Added the new docs/presentation-methods.md file and removed the large inlined block from README.md to improve readability.

Testing

  • Ran bundle install, which failed with a RubyGems 403 Forbidden error so dependencies were not installed.
  • Attempted bundle exec rspec, which could not run because the rspec executable was not available due to the failed bundle install.
  • Attempted bundle exec rubocop, which could not run for the same reason (missing gem executables after bundle install failure).

Codex Task

Summary by CodeRabbit

  • Documentation
    • ドキュメント構成を整理し、関連資料への案内をわかりやすくしました。
    • プレゼンテーションメソッドの仕様・利用手順をまとめた新しいガイドを追加しました。
    • ロードマップ、ライセンス、行動規範、更新履歴へのリンクを追加しました。

@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

README.mdの「Presentation methods」章を簡略化し「Project resources」セクションを新設、Roadmap/Licenseの並びを変更した。新規に docs/presentation-methods.md を追加し、データ駆動メソッド機能のYAMLスキーマ、Ruby設計、CLI/プラグイン連携、ローカライズ方針、OSS貢献手順を記載した。

Changes

ドキュメント再編

Layer / File(s) Summary
README構成の簡略化とリソース追加
README.md
「Presentation methods」章を短い案内に置き換え、「Project resources」セクション(guide/Changelog/Code of conduct/License リンク)を新設し、Roadmap/Licenseの並び順を変更。
presentation-methodsドキュメントの概要と使用例
docs/presentation-methods.md
目的、使用例コマンド、ビルトインメソッド一覧、データファーストのメソッドシステムの流れを記載。
ディレクトリ構成とYAMLスキーマ定義
docs/presentation-methods.md
data/slidict/methods/のディレクトリ構成、YAMLスキーマの必須/任意項目、スライド要素のフィールドを明記。
Ruby設計・CLI・プラグイン連携
docs/presentation-methods.md
PresentationMethod等のRuby側クラス責務、ロード時検証、CLI操作、プラグインによるYAML自動発見の仕組みを説明。
ローカライズ方針とOSS貢献手順
docs/presentation-methods.md
localeフィールドによる将来のローカライズ運用方針と、新規メソッド提案のOSS貢献ワークフローを記載。

Estimated code review effort: 2 (Simple) | ~10 minutes

Poem

ぴょんと跳ねて README を軽くして
docs の草原、新しい巣を作った
YAML の種を並べて、locale の芽も添えて
スキーマ畑にレビューチェックの水やりを
🐇✨ さあ、次のスライドへ跳ぼう

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed README と新規 docs/presentation-methods.md の再編という変更内容を適切に要約しています。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/readme

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
README.md (1)

230-236: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

「Presentation method guide」の表記を統一する

リンクテキストが単数形 "Presentation method guide" ですが、リンク先ファイル名は複数形 presentation-methods.md です。セクション見出しの "Presentation methods"(複数形)や本文中の表記と統一すると読みやすくなります。

- - [Presentation method guide](docs/presentation-methods.md)
+ - [Presentation methods guide](docs/presentation-methods.md)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 230 - 236, The “Project resources” entry for
Presentation method guide should use a consistent plural form to match the
section heading and linked file name. Update the link text in README.md from the
singular wording to “Presentation methods guide” (or equivalent pluralized
wording) so it aligns with presentation-methods.md and the surrounding
“Presentation methods” terminology.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@README.md`:
- Around line 230-236: The “Project resources” entry for Presentation method
guide should use a consistent plural form to match the section heading and
linked file name. Update the link text in README.md from the singular wording to
“Presentation methods guide” (or equivalent pluralized wording) so it aligns
with presentation-methods.md and the surrounding “Presentation methods”
terminology.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5c0f6469-1a1c-4825-8f8e-45a7b01be554

📥 Commits

Reviewing files that changed from the base of the PR and between 4833d26 and 56750f9.

📒 Files selected for processing (2)
  • README.md
  • docs/presentation-methods.md

@abechan1 abechan1 merged commit 139d6c2 into main Jul 1, 2026
5 checks passed
@abechan1 abechan1 deleted the codex/readme branch July 1, 2026 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant