feat: Move docs to https://docs.espressif.com/projects/espressif-ide

[kolipakakondal]

Description

Please include a summary of the change and which issue is fixed.

Fixes # (IEP-XXX)

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• Test A
• Test B

Test Configuration:

• ESP-IDF Version:
• OS (Windows,Linux and macOS):

Dependent components impacted by this PR:

• Component 1
• Component 2

Checklist

• PR Self Reviewed
• Applied Code formatting
• Added Documentation
• Added Unit Test
• Verified on all platforms - Windows,Linux and macOS

Summary by CodeRabbit

• New Features

  • Introduced GitHub Actions workflows for building and deploying documentation to both preview and production servers.
  • Added extensive documentation for Espressif-IDE, covering installation, configuration, usage, and additional features.
  • Included a section on FAQs within the documentation.

• Chores

  • Updated .gitignore to ignore various .DS_Store files and directories for cleaner repository management.
  • Added documentation-specific dependencies to docs/requirements.txt.

• Documentation

  • Enhanced documentation with new sections on project prerequisites, starting a project, connecting devices, building, flashing, debugging, and monitoring output.

[coderabbitai]

Warning

Review failed

The pull request is closed.

Walkthrough

The updates predominantly introduce a comprehensive GitHub Actions workflow designed for documentation building and deployment, both for preview and production environments, targeting various branches. Additionally, several new documentation files and configurations tailored for Espressif-IDE have been added, covering installation, configuration, and feature specifics aimed at simplifying the development process for IoT applications using the ESP-IDF framework.

Changes

File/Path	Change Summary
.github/workflows/docs_build.yml	Introduced workflow for building and deploying documentation on certain branch pushes and path changes.
.github/workflows/docs_production.yml	Introduced workflow for building and deploying documentation to production upon certain triggers.
.gitignore	Added ignore rules for .DS_Store files and directories under /docs and /.github/.
docs/README.md, docs/en/**/*.rst	Added new files providing detailed documentation for Espressif-IDE, including installation, configuration, and features.
docs/conf_common.py	Added new configurations for documentation generation, including extensions, context settings, and static paths.
docs/requirements.txt	Updated dependencies to include specific versions of esp-docs, sphinx-copybutton, and sphinx-tabs.
docs/utils.sh	Introduced Bash helper functions for adding SSH keys and configuring SSH settings for specific servers.

Poem

In cyberspace where actions play,
Espressif docs find their way.
Build and deploy with ease anew,
GitHub workflows guiding through.
Configs, installs, features bright,
All in docs, now clear in sight. 🐰📚

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[kolipakakondal]

We have structure in-place and able to publish it https://preview-docs.espressif.com/projects/espressif-ide/en/997-merge/index.html