docs: link READMEs to the runnable docs site#252
Closed
adamziel wants to merge 1 commit into
Closed
Conversation
Now that PR #244 is merged and GitHub Pages is enabled, add a banner pointing readers to https://wordpress.github.io/php-toolkit/ from the top of every component README, the root README, and the create-wp-site example. Component banners deep-link to the matching reference page so readers land directly on the live, executable snippets. The root README is also restructured around the docs site: the component list becomes a table where each row links to both the component README and its live reference page, and a callout makes the docs site the recommended source for code samples (verified in CI by the existing snippet-tests workflow).
Collaborator
Author
|
Closing in favor of #256, which does the same README/component-banner work plus the Packagist composer.json metadata, repo homepage, and AGENTS.md pointer. The branch this PR was based on predates the markdown-source migration in #254, so the diff has drifted; #256 was authored against the post-#254 trunk. |
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.
Summary
examples/create-wp-site/README.md. Each component banner deep-links to its matching reference page on the live site (e.g. reference/zip.html).trunkin CI by the existingsnippet-tests.ymlworkflow.Repo settings (already applied via the API)
docs.ymlworkflow added in Runnable docs site: live examples for every component #244 now publishes).Standalone, dependency-free PHP libraries for WordPress and PHP projects — XML, ZIP, Git, HTTP, Markdown, Filesystem, and more.https://wordpress.github.io/php-toolkit/.Follow-ups (separate PRs)
bin/run-snippets.pyso CI fails on any snippet without expected output that isn't explicitly Playground-only — closes the gap that today only enforces snippets already inbin/_expected_outputs.json.bin/_docs_components.pyso per-componentREADME.md(or siblingdocs.md) is the source of truth for snippets — fenced ```php blocks plus HTML-comment frontmatter for snippet metadata.Test plan
trunksucceeds and the linked URLs all resolve.<!-- docs-site-banner -->markers are HTML comments, so they're hidden in rendered output).🤖 Generated with Claude Code