Skip to content

Prepare 2.0.0 documentation and simplify publisher branding - #63

Merged
SirDarcanos merged 1 commit into
mainfrom
docs/release-presentation
Oct 21, 2026
Merged

SirDarcanos merged 1 commit into
mainfrom
docs/release-presentation

Conversation

@SirDarcanos

Copy link
Copy Markdown
Contributor

Summary

Simplifies the documentation to lead with Wistia PHP: publisher branding is removed from the header, page titles, introductory prose and favicon, while footer credit and required PHP namespaces/package identifiers remain intact.

The header and footer now share the centered body container. Mobile layouts wrap long inline method names and leave footer text clear of the back-to-top control. Reader-facing copy, examples and generator metadata present 2.0.0, with ^2.0 installation guidance instead of development-version instructions.

Historical installation bookmarks remain supported through a generated anchor, with a regression guard. The stale Client API-reference description is also corrected; runtime behavior is unchanged.

Verification

Documentation build, links, snippets and responsive guide/API checks passed. Independent Standards and Spec reviews completed; their shared bookmark finding was corrected, tested and independently re-reviewed without remaining issues.

This prepares the documentation only—it does not tag or publish a 2.0.0 package. Merging triggers the existing documentation publishing workflow.

Validation details
  • Baseline: 58529f2b4d9e3388e1bfee0b4bb40f484c606509; delivered commit: 69e0af68a9e5dfeacdc8be3ff2b3f9e93d4d1118. All 31 reviewed source/support content, mode and absence fingerprints were preserved after commit; the working tree is clean.
  • php tools/docs/build.php && php tools/docs/check.php: passed, 1,606 HTML pages. Checks include links/anchors, release copy, footer-only publisher credit, navigation and publish boundaries.
  • php tools/docs/check-examples.php: 35 PHP fragments checked; actual tutorial and migration reads executed through synthetic transports.
  • php tools/docs/check-repository-links.php: 495 local links passed. PHP 8.4 lint of changed PHP/docblock sources, JavaScript syntax and git diff --check passed. Generated-page/snippet/repository-link checks were renewed after the content-identical commit.
  • Isolated installed Chrome/CDP rendered an Upload guide and Client API page at 390, 1280 and 1920px. All six geometry checks passed: header/body/footer widths 375, 1201.75 and 1400px, centered within the content viewport excluding the scrollbar. Footer follows both floated columns; no page horizontal overflow. Mobile menu visibility and screenshots were inspected. agent-browser was unavailable, so no new browser package was installed. The temporary preview server/profile were stopped/removed.
  • Screenshots revealed and led to correction of long inline-code overflow and footer/back-to-top overlap. Code blocks/tables retain local scrolling; content is not hidden to mask overflow.
  • Negative rendered fixtures verified rejection of header publisher text and an Unreleased badge. A separate missing-legacy-installation-ID fixture exited 1 with the expected diagnostic; the generated original was restored and the checker passed. Both install-the-package and historical install-the-development-package now survive generation.
  • Independent read-only Standards and Spec reviews inspected the same frozen delivery. Their sole navigation finding shared one repair; both affected axes were renewed on the four-file correction and found no issues. Other source/layout inputs remained unchanged, so their visual evidence was retained. Build, acceptance and reporting gates pass for this bounded documentation change.
  • Test accounting: zero PHPUnit test files/methods added, removed or changed; no full-library rerun is claimed. Protection changes are the generated-site release/branding/anchor checks and revised responsive geometry assertions, including negative-fixture execution. Client source differs only in its public documentation comment.
  • No CI jobs/triggers, dependencies, API signatures or runtime behavior changed. Existing PR documentation build remains; successful current-main builds publish the site. Hosted compute/duration impact is unmeasured; no performance claim.
  • Documentation/internal-only impact: no release-impact label, version bump, tag or package release. Changelog remains under Unreleased to avoid inventing a published release. Internal context explicitly distinguishes release-ready reader copy from actual publication.
  • Namespace/source/license identity and original branding asset provenance are preserved. Only the new neutral monogram and existing CSS are published; old publisher logo/favicon assets are no longer copied into the site.
  • No live Wistia calls or destructive operations. Published-package installation is not verified or claimed by this docs change. Source rollback is possible without application data migration; rollback itself was not exercised.

Keep publisher credit in the footer, center header/footer on the body container, and retain historical installation bookmarks with generated-page checks.
@SirDarcanos
SirDarcanos merged commit c4579a3 into main Oct 21, 2026
2 checks passed
@SirDarcanos
SirDarcanos deleted the docs/release-presentation branch October 21, 2026 07:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant