Skip to content

update vscode extension create from example document#1603

Open
brianignacio5 wants to merge 1 commit into
espressif:masterfrom
brianignacio5:docs/vscode-extension
Open

update vscode extension create from example document#1603
brianignacio5 wants to merge 1 commit into
espressif:masterfrom
brianignacio5:docs/vscode-extension

Conversation

@brianignacio5
Copy link
Copy Markdown
Contributor

Description

This pull request updates the VS Code Extension setup instructions in the ESP-ADF documentation to reflect recent changes in configuration and workflow. The most important changes clarify how to set the ESP-ADF path and update the process for creating new projects from examples.

Documentation and workflow updates:

  • Updated instructions for setting the ESP-ADF path: users should now set the path using the idf.customExtraVars setting with ADF_PATH as the key, instead of the previous idf.espAdfPath or idf.espAdfPathWin settings.
  • Revised the process for creating new projects: users now use the new project command, select the ESP-IDF version, and choose ESP-ADF examples if configured, with additional configuration options for the new project (directory, name, etc.).

Related

VS Code extension for ESP-IDF Start a project documentation

Testing

Documentation change.

Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 14, 2026

CLA assistant check
All committers have signed the CLA.

@brianignacio5
Copy link
Copy Markdown
Contributor Author

PTAL @jason-mao

@jason-mao
Copy link
Copy Markdown
Collaborator

@brianignacio5 Thank you for your contribution.

@jason-mao
Copy link
Copy Markdown
Collaborator

@brianignacio5 Could you please change the target branch to release/v2.x, since the master branch contains breaking changes and does not sync the docs?

@brianignacio5
Copy link
Copy Markdown
Contributor Author

Please see #1604 for release/v2.x PR

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants