Promote the Feature Reference into a full Manual#99
Conversation
The docs had a strong feature reference but no manual: it started at "Features"
with no installation, module wiring, or SQL-file conventions, so a reader who
landed on /reference/ could not learn how to bootstrap the library. The only
setup-bearing doc (docs/ja/MediaQuery.md) is thin and unlinked.
Add the missing front sections to docs/reference.md and reposition it as the
Manual:
- Installation (composer require, requirements).
- Setup — both module entry points (MediaQuerySqlModule auto-discovery, the
recommended path; MediaQueryModule explicit list) plus AuraSqlModule for the
connection, and resolving the interface from the injector. Verified against
tests/MediaQuerySqlModuleTest.php.
- SQL Files — location, {queryId}.sql naming, named placeholders, multi-statement.
- Configuration — DSN/connection, module choice, advanced hooks.
- A short "This manual covers" table of contents.
Retitle to "Ray.MediaQuery Manual" (permalink /reference/ kept for link stability)
and update the README link and docs Home card from "Feature Reference" to "Manual".
|
Warning Review limit reached
More reviews will be available in 57 minutes and 39 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
@coderabbitai review この PR は |
🧩 Analysis chain🏁 Script executed: #!/bin/bash
# Read the updated docs/reference.md
echo "=== docs/reference.md ==="
cat docs/reference.md
echo ""
echo "=== tests/MediaQuerySqlModuleTest.php ==="
cat tests/MediaQuerySqlModuleTest.php
echo ""
echo "=== src/ directory structure ==="
tree src/
echo ""
echo "=== MediaQuerySqlModule.php ==="
fd "MediaQuerySqlModule.php" --exec cat {}
echo ""
echo "=== MediaQueryModule.php ==="
fd "MediaQueryModule.php" --exec cat {}
echo ""
echo "=== DbQueryConfig.php ==="
fd "DbQueryConfig.php" --exec cat {}
echo ""
echo "=== Queries.php (or similar) ==="
fd "Queries.php" --exec cat {}
echo ""
echo "=== README.md ==="
cat README.md
echo ""
echo "=== docs/index.html ==="
cat docs/index.html 2>/dev/null || echo "NOT FOUND"Length of output: 37638
✅ 検証済み（問題なし）
|
|
Closing because the manual promotion content has been incorporated into #100, which is now the consolidated documentation update PR. |
1 participant
Summary
The docs had a strong feature reference but no manual.
docs/reference.mdstarted at "Features" with no installation, module wiring, or SQL-file conventions, so a reader who landed on/reference/could learn how to write a query but not how to bootstrap the library. The only setup-bearing doc (docs/ja/MediaQuery.md) is thin and unlinked from the README / docs home.This PR adds the missing front sections to
docs/reference.mdand repositions it as the Manual. Docs only — no code or behavior changes.Changes
docs/reference.md— retitled to "Ray.MediaQuery Manual" (permalink/reference/kept for link stability) and prepended:composer require, requirements (PHP 8.2+, PDO driver, Ray.Di / Ray.AuraSqlModule).MediaQuerySqlModule(directory auto-discovery, recommended) andMediaQueryModule(explicitQuerieslist), plusAuraSqlModulefor the connection and resolving the interface from the injector.{queryId}.sqlnaming, named placeholders bound by argument name, multi-statement behavior.README.md/docs/index.html— relabeled the "Feature Reference" link/card to "Manual".Verification
tests/MediaQuerySqlModuleTest.php(new MediaQuerySqlModule(interfaceDir, sqlDir)+new AuraSqlModule('sqlite::memory:')) and the module/Queries/DbQueryConfigconstructor signatures insrc/.## Features.