Skip to content

Publish Wistia PHP documentation and direct readers to the site - #60

Merged
SirDarcanos merged 1 commit into
mainfrom
docs/documentation-site
Oct 17, 2026
Merged

SirDarcanos merged 1 commit into
mainfrom
docs/documentation-site

Conversation

@SirDarcanos

Copy link
Copy Markdown
Contributor

Summary

Add the public Wistia PHP documentation website for the unreleased 2.0 API, with a first-call tutorial, task-based guides, reference, concepts and framework integrations. The site includes generated PHP API documentation, Automattic branding and a “Hosted at Spacefast” footer.

README now directs users to the website. Remove 14 duplicate usage guides while retaining the website's Markdown build sources, agent guidance, internal wire contracts and historical helper verification evidence. Update affected links rather than leaving stale paths.

Pull requests build and validate the documentation. Successful main builds publish only generated files to the existing Spacefast site using its restricted repository secret. No library behavior, dependency constraints or release status changes.

Verification

Local documentation, snippet, repository-link and inventory checks passed. Independent Standards and Spec reviews covered the site rewrite; the final deletion/link migration is also reviewed before merge. PHP snippets other than the synthetic first-call tutorial were not executed against Wistia.

Validation details
  • php tools/docs/build.php — pinned, SHA-256-verified phpDocumentor 3.10.0.
  • php tools/docs/check.php — 1,600 HTML pages checked for links, anchors, navigation, branding and publish boundaries.
  • sandbox-exec -p '(version 1)(allow default)(deny network*)' php tools/docs/check-examples.php — 33 fragments checked for syntax, imports, known methods and constructor names; actual tutorial executed with one synthetic read under OS-enforced network denial.
  • php tools/docs/check-repository-links.php — 439 local links across 48 Markdown files.
  • php -d allow_url_fopen=0 tools/check-inventory.php --self-test — accounting/consistency and 22 rejection cases passed. Existing Upload/S3 source-contract gaps remain explicit; this is not whole-library acceptance.
  • PHP syntax, workflow YAML parsing, credential-pattern/file-boundary inspection and git diff --check passed.
  • Chromium checks covered desktop/mobile navigation, current-page markers, legacy-URL transitions and 15 page/viewport layout combinations at 390px, 1280px and 1920px. Hosted checks passed for the current site.
  • Zero existing PHPUnit test files changed. New checks protect documentation and its offline tutorial; no live Wistia calls, framework installations or ordinary library PHPUnit runs were performed for this documentation change.
  • Two CI jobs are introduced: documentation build/check and main-only deployment. Performance/cost changes are unmeasured. No branch-protection requirements are added. The deployment secret is already configured.
  • Documentation-only change: no changelog entry or release-impact label. No version bump, tag, release or issue closure.

@SirDarcanos
SirDarcanos merged commit 57133ef into main Oct 17, 2026
2 checks passed
@SirDarcanos
SirDarcanos deleted the docs/documentation-site 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