Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ide phpstorm debugging #344

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

marcorensch
Copy link
Contributor

@marcorensch marcorensch commented Dec 6, 2024

User description

Added an introduction on how to setup Xdebug with MAMP & PhpStorm.


PR Type

documentation


Description

  • Added a detailed guide on setting up Xdebug with MAMP and PhpStorm for Joomla! extensions debugging.
  • Updated documentation to correct the casing of PhpStorm.
  • Improved links to PhpStorm documentation for better navigation.

Changes walkthrough 📝

Relevant files
Documentation
index.md
Update PhpStorm documentation link and casing                       

docs/get-started/ide/index.md

  • Updated link to PhpStorm documentation.
  • Corrected the casing of PhpStorm.
  • +1/-1     
    debugging.md
    Add guide for PhpStorm debugging with MAMP and Xdebug       

    docs/get-started/ide/phpstorm/debugging.md

  • Added a comprehensive guide for setting up Xdebug with MAMP and
    PhpStorm.
  • Included instructions for enabling Xdebug in MAMP.
  • Provided steps for configuring PhpStorm debugger.
  • Added images and notes for clarity.
  • +142/-0 
    index.md
    Correct PhpStorm casing in title                                                 

    docs/get-started/ide/phpstorm/index.md

    • Corrected the casing of PhpStorm in the title.
    +1/-1     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    qodo-merge-pro bot commented Dec 6, 2024

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Documentation Clarity
    The port number mentioned in the documentation (8890) may not be the default MAMP port. Consider clarifying if this is a custom port or update to the default MAMP port.

    Missing Information
    The documentation should specify the minimum required versions of MAMP and PhpStorm for this setup to work properly.

    Content Organization
    Multiple empty lines at the end of the file should be removed to maintain clean documentation.

    Copy link
    Contributor

    qodo-merge-pro bot commented Dec 6, 2024

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Maintain consistent and correct product name capitalization throughout documentation

    Fix the casing of 'PhpStorm' to match the official product name styling. JetBrains'
    IDE is officially styled as 'PhpStorm', not 'phpStorm'.

    docs/get-started/ide/index.md [19]

    -The two current leading IDEs are [Visual Studio Code](get-started/ide/visual-studio-code.md) and [phpStorm](get-started/ide/phpstorm/index.md)
    +The two current leading IDEs are [Visual Studio Code](get-started/ide/visual-studio-code.md) and [PhpStorm](get-started/ide/phpstorm/index.md)
    • Apply this suggestion
    Suggestion importance[1-10]: 5

    Why: The suggestion correctly identifies the need to maintain consistent branding by using the proper capitalization of 'PhpStorm'. While this is a valid improvement for documentation quality, it's a relatively minor stylistic fix.

    5

    💡 Need additional feedback ? start a PR chat

    Copy link
    Member

    @HLeithner HLeithner left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Do you have links to existing documentation? so that even if this documentation is outdated the read might have a resource with an update documentation, maybe provided by phpstorm or xdebug?

    Please add such links to documentation.

    @@ -0,0 +1,142 @@
    Debugging
    ========
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Suggested change
    ========
    =========

    Comment on lines +29 to +33
    :::note

    After you have changed some settings make sure to save & restart your MAMP Server.

    :::
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Suggested change
    :::note
    After you have changed some settings make sure to save & restart your MAMP Server.
    :::
    :::note
    After you have changed some settings make sure to save & restart your MAMP Server.
    :::


    In this new Project select `Run` from the Main Menu and Select `Edit Configurations`.

    ![Edit Configurations Menu](./assets/run_edit_configurations.png)
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Suggested change
    ![Edit Configurations Menu](./assets/run_edit_configurations.png)
    ![Edit Configurations Menu](./assets/run_edit_configurations.png)

    Please move all images from "assets" to "_assets" folder

    Comment on lines +83 to +84
    your Server here. In this case here the Joomla! Installation is available on the URL `https://joomla5.local:8890` so the
    Host Name is `joomla5.local`. Set now the Hostname and Port based on your configuration.
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    .local is a reserved tld top level domain which is used for mdns.

    please use joomla5.example.com for documentation or .internal for real internal dns usage.

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

    Successfully merging this pull request may close these issues.

    2 participants