docs(readme): rewrite the "library" example to match the real surface#62
Merged
Conversation
The old snippet handed the reader an opaque \$item via iManager's low-level ItemRepository->find(1). Three things wrong with that: 1. \$item is the abstract polytype — page/user/file/whatever. The reader doesn't know what they got. 2. ID 1 is magic; a fresh install may not even have it. 3. "Use Scriptor as a library" framing was undermined by reaching straight into iManager instead of using Scriptor's own surface. Switch to require boot.php (single line — autoloader, container, \$config all set up). Then show the two natural library use-cases end-to-end: page data access via \$site->pages()->findHome(), and theme rendering via \$site->execute() + \$site->render(). Both smoke-tested against the live DB.
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
1 participant
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.
The old snippet handed the reader an opaque $item via iManager's low-level ItemRepository->find(1). Three things wrong with that:
Switch to require boot.php (single line — autoloader, container, $config all set up). Then show the two natural library use-cases end-to-end: page data access via $site->pages()->findHome(), and theme rendering via $site->execute() + $site->render(). Both smoke-tested against the live DB.