update the quick start and key features cards - #31
Merged
Merged
Conversation
|
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
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.
Brings the home page cards in line with what the site actually says.
Quick Start — the old snippet contradicted the documentation twice. It set
XDEBUG_TRIGGER=1, which Quick Start step 2 ("Delete everything else") explicitly tells people to remove, and it wrotezend_extension=php_debuggerwithout the.so, when the interpreter build the installer provides needs no line at all.It now shows the installer command followed by
php your-script.php— the second command being nothing more than running your code is the point, made visually — with "Install it. There is nothing to configure." above and "Start your editor listening, set a breakpoint, run your code." below.The command is OS-aware: a Windows visitor gets the PowerShell one-liner with PowerShell highlighting. Rather than duplicating the logic, the two commands and the platform detection moved out of
InstallCommandintosrc/lib/installer.js, which both the Installation page and the card import, so they cannot drift apart. It uses the same hydration-safe pattern as the Installation page — render the Unix command server-side, correct it in an effect after mount.Key Features — "Interactive CLI debugger" was not true (there is no CLI interface; it is a DBGp server the editor drives), and "Exception handling" and "Logging and error handling" were vague, the latter naming a page that no longer exists. Replaced with six items that are all documented and are a subset of the Introduction page's benefits, so the card and the page it links to agree:
IDE Support — adds "Any other editor with PHP debugging" as a third entry, so the card no longer reads as a list of only two supported editors. Worded without "DBGp", which appears nowhere else on the home page.
The installer URL is longer than the card is wide and was being clipped mid-URL, so code blocks in the card body now wrap.
Verified in the browser: the card renders correctly on macOS, and the Installation page's platform tabs still swap to the PowerShell command after the refactor.