You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: scrub references to a specific consumer (Scriptor) throughout (#27)
* docs: scrub references to a specific consumer (Scriptor) throughout
iManager is a general-purpose embeddable CMS framework. Calling out
one specific host application (Scriptor) implies a primary / blessed
consumer that doesn't exist — the library is consumer-agnostic and
the docs should read that way.
Rewrites all consumer-naming mentions across user-facing and planning
docs, and moves the host-side cutover plan into the host's own repo.
Changes
-------
User-facing:
- `README.md` — drops "the reference consumer is Scriptor", drops
"shipped with Scriptor ≤ 1.x" and "use Scriptor ≤ 1.x" framing,
drops the link to the Scriptor-integration phase plan.
- `CHANGELOG.md` — Phase 12 cache invalidation hook and Phase 14e
files entries lose their "(Scriptor's …)" call-outs in favour of
the underlying capability.
- `docs/migration-guide.md` — Step 5 drops the "Scriptor's own
switchover is documented in …" reference; the workaround note
describes a self-referential parent field generically.
- `docs/api/README.md`, `docs/api/domain.md`, `docs/api/field-types.md`
— three stray references rewritten generically (cache subsystem
blurb, lazy-listener tip, render() motivation).
Planning:
- `docs/imanager-2.0-plan.md` — Phase 14 reframed as "First-Consumer-
Cutover (Release-Gate)"; release strategy, phase-status row, and
acceptance criteria use host-neutral language.
- `docs/imanager-analysis.md` — header reframes as a 1.x analysis;
drops the "embedded in Scriptor 1.12.1" framing.
Removed:
- `docs/imanager-2.0-phase-14-plan.md` — this is the consumer-side
cutover detail plan; it belongs in the consumer's own docs/.
* ci: strip auto-set GitHub OAuth from composer auth before install
`shivammathur/setup-php@v2` automatically copies `secrets.GITHUB_TOKEN`
into Composer's global `github-oauth.github.com` config to lift the
unauthenticated Packagist rate limit. GitHub now issues JWT-shaped
`ghs_*` installation tokens (uppercase letters, dots, dashes), which
Composer 2.x's `BaseIO::setAuthentication` validation regex rejects
as "invalid characters" — `composer install` then dies before
fetching any dependency.
We don't actually need the token for public-Packagist installs (the
unauthenticated limit is fine for our matrix). Unset the OAuth entry
right after `setup-php` runs and let Composer fall back to anonymous
requests.
Bundled into this docs PR so the PR's CI can go green on this branch
— a CI infra hotfix on a standalone branch wouldn't help, since CI
runs the workflow file from the PR branch itself.
Copy file name to clipboardExpand all lines: docs/api/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ tells you which source file to read next.
51
51
|`Imanager\Enum`|`FieldType` (the 16 built-in enum cases), `SqliteAffinity` (storage class hint), `InputErrorCode` (validation error codes). |`src/Enum/`|
52
52
|`Imanager\Files`| File-storage abstraction (`FileStorage` interface, `LocalFileStorage`), upload validation, and `ImageProcessor` for on-demand thumbnails. `FileRepository` (under `Storage`) tracks file *metadata*; this subsystem moves the bytes. |`src/Files/`|
53
53
|`Imanager\Http`| Small request-layer toolkit: `SessionStore` (with `NativeSessionStore` default), `Csrf` (per-form tokens, capped LRU), and request/URL helpers. iManager does *not* ship a router. |`src/Http/`|
54
-
|`Imanager\Cache`| PSR-16 cache contract and `FilesystemCache` (hash-keyed, two-level directory fanout, TTL metadata in-file). Used by Scriptor for section-cache; library itself stays uncached for predictability. |`src/Cache/`|
54
+
|`Imanager\Cache`| PSR-16 cache contract and `FilesystemCache` (hash-keyed, two-level directory fanout, TTL metadata in-file). Hosts wire it to whatever they want to cache (rendered fragments, query results, …); the library itself stays uncached for predictability. |`src/Cache/`|
55
55
|`Imanager\Search`|`FullTextSearch` over a SQLite FTS5 mirror of `items`. CLI command `fts:rebuild` rebuilds the index from scratch. |`src/Search/`|
56
56
|`Imanager\Templating`| Single-purpose `{{var}}` substitution for short strings (pagination links, alerts). Caller is responsible for escaping. **Not** a view layer. |`src/Templating/`|
57
57
|`Imanager\Validation`|`Sanitizer` facade over HTMLPurifier (sanitize) and Parsedown (markdown). Pure functions; safe to call repeatedly. |`src/Validation/`|
0 commit comments