Add README#118
Conversation
Add comprehensive documentation for the PHP extension, covering capabilities, limitations, prerequisites, installation, configuration, debugging, contributing, and useful links.
There was a problem hiding this comment.
Pull request overview
Adds an initial comprehensive README.md for the PHP Zed extension to document capabilities/limitations and provide setup/configuration/debugging/contributing guidance (addressing Issue #105).
Changes:
- Introduces a full README describing language server options, syntax/highlighting features, and Xdebug debugging.
- Adds configuration examples for Zed settings and Tailwind CSS language server integration.
- Documents contributing/build steps and repository file layout.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - **Tree-sitter grammar** ([tree-sitter/tree-sitter-php](https://github.com/tree-sitter/tree-sitter-php)) for fast, local, offline parsing | ||
| - **PHPDoc syntax highlighting** ([claytonrcarter/tree-sitter-phpdoc](https://github.com/claytonrcarter/tree-sitter-phpdoc)) inside doc comment blocks | ||
| - Language injection: HTML, CSS, JavaScript, and SQL embedded in PHP files are highlighted in their respective grammars |
| - **Outline panel** showing classes, methods, and functions | ||
| - **Symbol indexing** for workspace-wide navigation | ||
| - **Test detection** — automatically detects PHPUnit test methods for run/debug from the editor | ||
| - **Text objects** for selecting PHP constructs (functions, classes, arguments) |
| { | ||
| "label": "PHP: Listen to Xdebug", | ||
| "adapter": "Xdebug", | ||
| "request": "launch", |
MrSubidubi
changed the title
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a comprehensive README.md documenting the Zed PHP extension’s features, configuration, debugging workflow, contribution guidelines, and related links, addressing Issue #105’s request for capability/limitation documentation.
Changes:
- Documented supported language servers (Phpactor/Intelephense/PHP Tools), syntax highlighting, runnables, and Xdebug debugging.
- Added setup/config examples for Zed settings and Tailwind CSS language injection.
- Added contributor-oriented sections (build, local dev, code quality commands, repo layout).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
MrSubidubi
left a comment
MrSubidubi
left a comment
There was a problem hiding this comment.
Thanks for this!
I think you are right a README would be worth it, but this is way too large and wrong in many aspects. Could we start with something more minimal like just provided language servers and a bit of debug information instead? Optimally, no more than 80 lines or only more if it really adds value. After all, it should be a README, not a READMEIFYOUFINDTHETIMETODOSO
MrSubidubi
changed the title
Add comprehensive documentation for the PHP extension, covering capabilities, limitations, prerequisites, installation, configuration, debugging, contributing, and useful links.
Generated by Claude. :) But it may be a better start then no README.md at all.
#105