Update and enhance Kedro VSCode extension documentation

[jitu5]

Description

Resolves #4458

This pull request includes several changes to the documentation, primarily focusing on improving the organization and clarity of the setup guides for VS Code.

Development notes

• docs/source/development/debugging.md: Updated the link for "Debugging in VS Code" to point to the new location under the visual_studio_code_extension directory.
• docs/source/get_started/install.md: Updated the links for setting up VS Code and the Kedro VS Code Extension to point to the new location under the visual_studio_code_extension directory.
• docs/source/development/index.md: Removed the outdated reference to the VS Code setup guide.
• docs/source/index.rst: Added a new toctree section for the Kedro VS Code Extension to improve navigation.

New content for VS Code extension:

• docs/source/visual_studio_code_extension/set_up_vscode.md: Added detailed instructions on setting a custom Kedro project path, including using the command palette, VS Code settings UI, and multi-root workspace integration. This file was renamed from docs/source/development/set_up_vscode.md.

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

• Read the contributing guidelines
• Signed off each commit with a Developer Certificate of Origin (DCO)
• Opened this PR as a 'Draft Pull Request' if it is work-in-progress
• Updated the documentation to reflect the code changes
• Added a description of this change in the RELEASE.md file
• Added tests to cover my changes
• Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

[astrojuanlu]

Does this clash with #4542 ?

[astrojuanlu]

Thanks a lot @jitu5 ! Content-wise, the diff here looks good.

Having said that, I'm now reflecting on what I wrote in #4458 and the investigation we did for kedro-org/vscode-kedro#151, and I think it's worth making some changes to the Information Architecture...

What about something like this?

Hence

• "Development" as its own heading, so now VS Code is directly visible without expanding
• The CLI reference in a more visible place (see Improve reference documentation for the CLI #2604)

This is what I did locally to create the screenshot:

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 501028cf..6d264a16 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -91,6 +91,16 @@ Welcome to Kedro's award-winning documentation!
    integrations/kedro_dvc_versioning.md
    integrations/deltalake_versioning.md
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Development
+
+   development/set_up_vscode
+   development/set_up_pycharm
+   development/debugging
+   development/automated_testing
+   development/linting
+
 .. toctree::
    :maxdepth: 2
    :caption: Advanced usage
@@ -99,20 +109,19 @@ Welcome to Kedro's award-winning documentation!
    extend_kedro/index.md
    hooks/index.md
    logging/index.md
-   development/index.md
    deployment/index.md
 
 .. toctree::
    :maxdepth: 2
-   :caption: Kedro VS Code Extension
+   :caption: Contribute to Kedro
 
-   visual_studio_code_extension/set_up_vscode.md
+   contribution/index.md
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contribute to Kedro
+   :caption: CLI reference
 
-   contribution/index.md
+   development/commands_reference.md
 
 API documentation
 =================

[astrojuanlu]

💯

[astrojuanlu]

Maybe

Suggested change

	### Ways to set a custom path for Kedro project:
	#### Using the command palette
	### Set up a custom path using the command palette

(and same with the other H4 below)

[astrojuanlu]

Other comments, not entirely related to this PR:

• There's "Logging" and "Default logging configuration" because there are 2 H1s in logging.md
• Can we use this opportunity to address Setup Visual Studio Code: Windows command for finding Kedro CLI script #4384 ?

[ravi-kumar-pilla]

Will there be any quick way to check the extension has picked up the new project path ? Like some kind of logger or console output which can help users confirm of the change ?

[astrojuanlu]

Also adding @iamelijahko as reviewer, since this is somehow connected to the onboarding flow

[ravi-kumar-pilla]

Hi @jitu5 , The docs look great. I echo with @astrojuanlu suggestion on having a development section. I left a minor comment but everything else looks good. Thank you