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

Docs: Initial documentation structure using Sphinx #5355

Merged
merged 12 commits into from
Jul 19, 2021

Conversation

pedrominatel
Copy link
Member

This PR is the initial documentation structure including the basic information about the project and Sphinx configuration.

CONTENTS:

  • Getting Started
  • Installing
  • Boards
  • Libraries
  • Library Builder
  • Tutorials
  • ESP-IDF as Component
  • OTA Web Update
  • makeEspArduino
  • Troubleshooting
  • Contributing

This PR also changes the README.md.

@pedrominatel pedrominatel added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Jul 5, 2021
@pedrominatel pedrominatel self-assigned this Jul 5, 2021
@pedrominatel
Copy link
Member Author

PTAL @me-no-dev and let me know if any other change is required.

Copy link
Collaborator

@VojtechBartoska VojtechBartoska left a comment

Choose a reason for hiding this comment

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

Few notes and content Table fix of Readme.md file.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@wujiangang
Copy link

Can we move Installing and Boards sections under Getting Started? Add a section named such as Advanced Utilities, and move Library Builder, ESP-IDF as Component, OTA Web Update, makeEspArduino inside. So the CONTENTS will be concise.

Copy link
Member Author

@pedrominatel pedrominatel left a comment

Choose a reason for hiding this comment

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

Can we move Installing and Boards sections under Getting Started? Add a section named such as Advanced Utilities, and move Library Builder, ESP-IDF as Component, OTA Web Update, makeEspArduino inside. So the CONTENTS will be concise.

I just think we should keep Library Builder and ESP-IDF as Component as is because both are often used. We can move them to Advanced Utilities when the content index gets bigger.

README.md Outdated Show resolved Hide resolved
@me-no-dev me-no-dev merged commit 1effae4 into master Jul 19, 2021
@me-no-dev me-no-dev deleted the docs/initial_version branch July 19, 2021 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants