Fix manual and tutorial documentation#102
Draft
koriym wants to merge 3 commits into
Draft
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".
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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 |
Accept 1.x content in all four conflicting files: - README.md: use simplified documentation section from 1.x - docs/reference.md: use Japanese front matter and inline labels from 1.x - docs/index.html: use BDR card and JS language switcher from 1.x - docs/tutorial/README.ja.md: use マニュアル label from 1.x https://claude.ai/code/session_01HWD3hygK9SGrLvZvehW28x
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
--no-devinstall flow, extension checks, and expected-output labels.Why
Follow-up review of PR #99 found several documentation traps for first-time users: missing extension prerequisites, autoload assumptions for
MediaQuerySqlModule, a non-null raw row example, a method listed outsideSqlQueryInterface, staleFeature Referencelabels, and tutorial setup wording that conflicted withcomposer install --no-dev.Validation
jekyll build --source docs --destination /private/tmp/ray-mediaquery-manual-fixes-site2composer validate --strictzsh -ic 'sphp85; find docs/tutorial/src -name "*.php" -exec php -l {} \;'zsh -ic 'sphp85; php -m | grep -E "^(PDO|mbstring|pdo_sqlite|tokenizer)$"'composer install --no-dev --no-interaction --no-progresszsh -ic 'sphp85; php docs/tutorial/src/run.php'