Skip to content

[1/3] docs: keep the PHP opening tag in API reference samples - #147

Merged
dazzatronus merged 1 commit into
mainfrom
derk/reference-php-open-tag
Sep 29, 2026
Merged

dazzatronus merged 1 commit into
mainfrom
derk/reference-php-open-tag

Conversation

@dazzatronus

@dazzatronus dazzatronus commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

Every PHP sample in the API reference is missing its first five lines. Shins runs sanitize-html over the markdown, code blocks included, and only exempts xml blocks, so <?php … > is stripped as if it were an HTML tag. This exempts php blocks too.

tests/reference-code-samples.cjs fails if any PHP sample loses its opening tag, and runs in CI after the docs build.

Verify: pnpm build:docs && node tests/reference-code-samples.cjs → PHP samples: 22 complete.

Stack (merge in order)

PR Adds Why it is separate
1/3 ← this PR #147 Keeps <?php in rendered PHP samples A Shins fix, independent of what the samples contain
2/3 #148 A small, valid example for every request body Spec data that the samples embed; also changes the published bundle
3/3 #149 Current-idiom sample templates and a check that runs them Depends on the examples; the check and templates must land together

@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.20.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant